Class: Aws::Athena::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Athena::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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` or `BUSY`.
-
#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`, or `BUSY`.
-
#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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
474 475 476 |
# File 'lib/aws-sdk-athena/client.rb', line 474 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3848 3849 3850 |
# File 'lib/aws-sdk-athena/client.rb', line 3848 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3851 3852 3853 |
# File 'lib/aws-sdk-athena/client.rb', line 3851 def errors_module Errors 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.
523 524 525 526 |
# File 'lib/aws-sdk-athena/client.rb', line 523 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`.
570 571 572 573 |
# File 'lib/aws-sdk-athena/client.rb', line 570 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.
647 648 649 650 |
# File 'lib/aws-sdk-athena/client.rb', line 647 def batch_get_query_execution(params = {}, = {}) req = build_request(:batch_get_query_execution, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 |
# File 'lib/aws-sdk-athena/client.rb', line 3821 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Athena') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-athena' context[:gem_version] = '1.101.0' Seahorse::Client::Request.new(handlers, context) 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.
673 674 675 676 |
# File 'lib/aws-sdk-athena/client.rb', line 673 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.
709 710 711 712 |
# File 'lib/aws-sdk-athena/client.rb', line 709 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.
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.
861 862 863 864 |
# File 'lib/aws-sdk-athena/client.rb', line 861 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.
923 924 925 926 |
# File 'lib/aws-sdk-athena/client.rb', line 923 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.
970 971 972 973 |
# File 'lib/aws-sdk-athena/client.rb', line 970 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.
1004 1005 1006 1007 |
# File 'lib/aws-sdk-athena/client.rb', line 1004 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].
[1]: docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access
1044 1045 1046 1047 |
# File 'lib/aws-sdk-athena/client.rb', line 1044 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.
1129 1130 1131 1132 |
# File 'lib/aws-sdk-athena/client.rb', line 1129 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`.
1156 1157 1158 1159 |
# File 'lib/aws-sdk-athena/client.rb', line 1156 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.
1198 1199 1200 1201 |
# File 'lib/aws-sdk-athena/client.rb', line 1198 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.
1224 1225 1226 1227 |
# File 'lib/aws-sdk-athena/client.rb', line 1224 def delete_named_query(params = {}, = {}) req = build_request(:delete_named_query, params) req.send_request() end |
#delete_notebook(params = {}) ⇒ Struct
Deletes the specified notebook.
1246 1247 1248 1249 |
# File 'lib/aws-sdk-athena/client.rb', line 1246 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.
1273 1274 1275 1276 |
# File 'lib/aws-sdk-athena/client.rb', line 1273 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.
1301 1302 1303 1304 |
# File 'lib/aws-sdk-athena/client.rb', line 1301 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.
1336 1337 1338 1339 |
# File 'lib/aws-sdk-athena/client.rb', line 1336 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.
1383 1384 1385 1386 |
# File 'lib/aws-sdk-athena/client.rb', line 1383 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.
1411 1412 1413 1414 |
# File 'lib/aws-sdk-athena/client.rb', line 1411 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.
1445 1446 1447 1448 |
# File 'lib/aws-sdk-athena/client.rb', line 1445 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.
1478 1479 1480 1481 |
# File 'lib/aws-sdk-athena/client.rb', line 1478 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.
1516 1517 1518 1519 |
# File 'lib/aws-sdk-athena/client.rb', line 1516 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.
1556 1557 1558 1559 |
# File 'lib/aws-sdk-athena/client.rb', line 1556 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.
1597 1598 1599 1600 |
# File 'lib/aws-sdk-athena/client.rb', line 1597 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.
1631 1632 1633 1634 |
# File 'lib/aws-sdk-athena/client.rb', line 1631 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.
1664 1665 1666 1667 |
# File 'lib/aws-sdk-athena/client.rb', line 1664 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.
1701 1702 1703 1704 |
# File 'lib/aws-sdk-athena/client.rb', line 1701 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.
1769 1770 1771 1772 |
# File 'lib/aws-sdk-athena/client.rb', line 1769 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.
[1]: docs.aws.amazon.com/athena/latest/ug/querying.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1846 1847 1848 1849 |
# File 'lib/aws-sdk-athena/client.rb', line 1846 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.
1906 1907 1908 1909 |
# File 'lib/aws-sdk-athena/client.rb', line 1906 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.
1966 1967 1968 1969 |
# File 'lib/aws-sdk-athena/client.rb', line 1966 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.
2001 2002 2003 2004 |
# File 'lib/aws-sdk-athena/client.rb', line 2001 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.
2057 2058 2059 2060 |
# File 'lib/aws-sdk-athena/client.rb', line 2057 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.
2109 2110 2111 2112 |
# File 'lib/aws-sdk-athena/client.rb', line 2109 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.
2171 2172 2173 2174 |
# File 'lib/aws-sdk-athena/client.rb', line 2171 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.
2212 2213 2214 2215 |
# File 'lib/aws-sdk-athena/client.rb', line 2212 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.
2286 2287 2288 2289 |
# File 'lib/aws-sdk-athena/client.rb', line 2286 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.
2333 2334 2335 2336 |
# File 'lib/aws-sdk-athena/client.rb', line 2333 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.
<note markdown=“1”> In the Athena console, data catalogs are listed as “data sources” on the **Data sources** page under the **Data source name** column.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2387 2388 2389 2390 |
# File 'lib/aws-sdk-athena/client.rb', line 2387 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.
2440 2441 2442 2443 |
# File 'lib/aws-sdk-athena/client.rb', line 2440 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.
2482 2483 2484 2485 |
# File 'lib/aws-sdk-athena/client.rb', line 2482 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.
2553 2554 2555 2556 |
# File 'lib/aws-sdk-athena/client.rb', line 2553 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.
2602 2603 2604 2605 |
# File 'lib/aws-sdk-athena/client.rb', line 2602 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.
2655 2656 2657 2658 |
# File 'lib/aws-sdk-athena/client.rb', line 2655 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.
2701 2702 2703 2704 |
# File 'lib/aws-sdk-athena/client.rb', line 2701 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.
2746 2747 2748 2749 |
# File 'lib/aws-sdk-athena/client.rb', line 2746 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.
2796 2797 2798 2799 |
# File 'lib/aws-sdk-athena/client.rb', line 2796 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.
2876 2877 2878 2879 |
# File 'lib/aws-sdk-athena/client.rb', line 2876 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.
2950 2951 2952 2953 |
# File 'lib/aws-sdk-athena/client.rb', line 2950 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.
2995 2996 2997 2998 |
# File 'lib/aws-sdk-athena/client.rb', line 2995 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.
3041 3042 3043 3044 |
# File 'lib/aws-sdk-athena/client.rb', line 3041 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.
3075 3076 3077 3078 |
# File 'lib/aws-sdk-athena/client.rb', line 3075 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.
<note markdown=“1”> The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.
</note>
3143 3144 3145 3146 |
# File 'lib/aws-sdk-athena/client.rb', line 3143 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*.
3246 3247 3248 3249 |
# File 'lib/aws-sdk-athena/client.rb', line 3246 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.
3323 3324 3325 3326 |
# File 'lib/aws-sdk-athena/client.rb', line 3323 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.
<note markdown=“1”> 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.
</note>
3362 3363 3364 3365 |
# File 'lib/aws-sdk-athena/client.rb', line 3362 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.
3388 3389 3390 3391 |
# File 'lib/aws-sdk-athena/client.rb', line 3388 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.
[1]: docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html
3436 3437 3438 3439 |
# File 'lib/aws-sdk-athena/client.rb', line 3436 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`.
3468 3469 3470 3471 |
# File 'lib/aws-sdk-athena/client.rb', line 3468 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.
3495 3496 3497 3498 |
# File 'lib/aws-sdk-athena/client.rb', line 3495 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.
3522 3523 3524 3525 |
# File 'lib/aws-sdk-athena/client.rb', line 3522 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.
3588 3589 3590 3591 |
# File 'lib/aws-sdk-athena/client.rb', line 3588 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.
3623 3624 3625 3626 |
# File 'lib/aws-sdk-athena/client.rb', line 3623 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.
3669 3670 3671 3672 |
# File 'lib/aws-sdk-athena/client.rb', line 3669 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.
3706 3707 3708 3709 |
# File 'lib/aws-sdk-athena/client.rb', line 3706 def (params = {}, = {}) req = build_request(:update_notebook_metadata, params) req.send_request() end |
#update_prepared_statement(params = {}) ⇒ Struct
Updates a prepared statement.
3740 3741 3742 3743 |
# File 'lib/aws-sdk-athena/client.rb', line 3740 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.
3812 3813 3814 3815 |
# File 'lib/aws-sdk-athena/client.rb', line 3812 def update_work_group(params = {}, = {}) req = build_request(:update_work_group, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3841 3842 3843 |
# File 'lib/aws-sdk-athena/client.rb', line 3841 def waiter_names [] end |