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 = {}) ⇒ Struct
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 = {}) ⇒ Struct
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.
419 420 421 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 419 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.
468 469 470 471 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 468 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
.
515 516 517 518 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 515 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.
592 593 594 595 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 592 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.
618 619 620 621 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 618 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.
654 655 656 657 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 654 def create_capacity_reservation(params = {}, = {}) req = build_request(:create_capacity_reservation, params) req.send_request() end |
#create_data_catalog(params = {}) ⇒ Struct
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.
744 745 746 747 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 744 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.
806 807 808 809 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 806 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.
853 854 855 856 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 853 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.
887 888 889 890 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 887 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.
927 928 929 930 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 927 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.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1012 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
.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1039 def delete_capacity_reservation(params = {}, = {}) req = build_request(:delete_capacity_reservation, params) req.send_request() end |
#delete_data_catalog(params = {}) ⇒ Struct
Deletes a data catalog.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1061 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.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1087 def delete_named_query(params = {}, = {}) req = build_request(:delete_named_query, params) req.send_request() end |
#delete_notebook(params = {}) ⇒ Struct
Deletes the specified notebook.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1109 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.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1136 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.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1164 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.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1199 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.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1246 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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1274 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.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1308 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.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1341 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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1379 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.
1416 1417 1418 1419 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1416 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1457 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.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1491 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.
1524 1525 1526 1527 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1524 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.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1561 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.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1629 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.
1706 1707 1708 1709 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1706 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. Query execution runtime statistics are returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.
1764 1765 1766 1767 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1764 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.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1824 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.
1859 1860 1861 1862 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1859 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.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1915 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.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1967 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.
2029 2030 2031 2032 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2029 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.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2070 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.
2144 2145 2146 2147 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2144 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.
2191 2192 2193 2194 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2191 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.
2242 2243 2244 2245 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2242 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.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2295 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.
2337 2338 2339 2340 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2337 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.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2408 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2457 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.
2510 2511 2512 2513 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2510 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.
2556 2557 2558 2559 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2556 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.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2601 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.
2651 2652 2653 2654 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2651 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.
2731 2732 2733 2734 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2731 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.
2805 2806 2807 2808 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2805 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.
2850 2851 2852 2853 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2850 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.
2896 2897 2898 2899 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2896 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.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2930 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.
2998 2999 3000 3001 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2998 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.
3101 3102 3103 3104 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3101 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.
3178 3179 3180 3181 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3178 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.
3217 3218 3219 3220 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3217 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.
3243 3244 3245 3246 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3243 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.
3291 3292 3293 3294 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3291 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
.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3323 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.
3350 3351 3352 3353 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3350 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.
3377 3378 3379 3380 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3377 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.
3443 3444 3445 3446 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3443 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.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3478 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.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3524 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.
3561 3562 3563 3564 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3561 def (params = {}, = {}) req = build_request(:update_notebook_metadata, params) req.send_request() end |
#update_prepared_statement(params = {}) ⇒ Struct
Updates a prepared statement.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3595 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.
3667 3668 3669 3670 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3667 def update_work_group(params = {}, = {}) req = build_request(:update_work_group, params) req.send_request() end |