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.
395 396 397 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 395 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.
444 445 446 447 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 444 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
.
491 492 493 494 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 491 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.
564 565 566 567 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 564 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.
590 591 592 593 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 590 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.
626 627 628 629 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 626 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.
721 722 723 724 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 721 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.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
790 791 792 793 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 790 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.
837 838 839 840 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 837 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.
871 872 873 874 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 871 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.
911 912 913 914 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 911 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.
987 988 989 990 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 987 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
.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1014 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.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1036 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.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
1069 1070 1071 1072 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1069 def delete_named_query(params = {}, = {}) req = build_request(:delete_named_query, params) req.send_request() end |
#delete_notebook(params = {}) ⇒ Struct
Deletes the specified notebook.
1091 1092 1093 1094 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1091 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.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1118 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.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1146 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.
1181 1182 1183 1184 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1181 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.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1228 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.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1256 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.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1290 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.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1323 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.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1361 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.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1393 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.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1428 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.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1462 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.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1495 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.
1532 1533 1534 1535 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1532 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.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1596 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.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1673 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1730 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.
1790 1791 1792 1793 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1790 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.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1825 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.
1875 1876 1877 1878 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1875 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.
1921 1922 1923 1924 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1921 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. 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.
1975 1976 1977 1978 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1975 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.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2016 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.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2090 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.
2137 2138 2139 2140 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2137 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2183 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.
2230 2231 2232 2233 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2230 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.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2272 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2343 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.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2399 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.
2452 2453 2454 2455 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2452 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.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2498 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.
2543 2544 2545 2546 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2543 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. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2599 2600 2601 2602 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2599 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.
2679 2680 2681 2682 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2679 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.
2747 2748 2749 2750 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2747 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.
2792 2793 2794 2795 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2792 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.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2837 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.
2871 2872 2873 2874 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2871 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.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2930 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.
3030 3031 3032 3033 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3030 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.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3107 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.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3146 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.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
3179 3180 3181 3182 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3179 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.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3227 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
.
3259 3260 3261 3262 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3259 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.
3286 3287 3288 3289 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3286 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.
3313 3314 3315 3316 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3313 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.
3379 3380 3381 3382 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3379 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.
3414 3415 3416 3417 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3414 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.
3460 3461 3462 3463 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3460 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.
3497 3498 3499 3500 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3497 def (params = {}, = {}) req = build_request(:update_notebook_metadata, params) req.send_request() end |
#update_prepared_statement(params = {}) ⇒ Struct
Updates a prepared statement.
3531 3532 3533 3534 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3531 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.
3598 3599 3600 3601 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3598 def update_work_group(params = {}, = {}) req = build_request(:update_work_group, params) req.send_request() end |