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
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_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.
-
#create_named_query(params = {}) ⇒ Types::CreateNamedQueryOutput
Creates a named query.
-
#delete_named_query(params = {}) ⇒ Struct
Deletes a named query.
-
#get_named_query(params = {}) ⇒ Types::GetNamedQueryOutput
Returns information about a single query.
-
#get_query_execution(params = {}) ⇒ Types::GetQueryExecutionOutput
Returns information about a single execution of a query.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
Returns the results of a single query execution specified by ‘QueryExecutionId`.
-
#list_named_queries(params = {}) ⇒ Types::ListNamedQueriesOutput
Provides a list of all available query IDs.
-
#list_query_executions(params = {}) ⇒ Types::ListQueryExecutionsOutput
Provides a list of all available query execution IDs.
-
#start_query_execution(params = {}) ⇒ Types::StartQueryExecutionOutput
Runs (executes) the SQL query statements contained in the ‘Query` string.
-
#stop_query_execution(params = {}) ⇒ Struct
Stops a query execution.
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.
212 213 214 |
# File 'lib/aws-sdk-athena/client.rb', line 212 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.
752 753 754 |
# File 'lib/aws-sdk-athena/client.rb', line 752 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.
755 756 757 |
# File 'lib/aws-sdk-athena/client.rb', line 755 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. Use ListNamedQueries to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries are different from executed queries. Use BatchGetQueryExecution to get details about each unique query execution, and ListQueryExecutions to get a list of query execution IDs.
259 260 261 262 |
# File 'lib/aws-sdk-athena/client.rb', line 259 def batch_get_named_query(params = {}, = {}) req = build_request(:batch_get_named_query, 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. To get a list of query execution IDs, use ListQueryExecutions. Query executions are different from named (saved) queries. Use BatchGetNamedQuery to get details about named queries.
309 310 311 312 |
# File 'lib/aws-sdk-athena/client.rb', line 309 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.
730 731 732 733 734 735 736 737 738 739 740 741 |
# File 'lib/aws-sdk-athena/client.rb', line 730 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-athena' context[:gem_version] = '1.7.0' Seahorse::Client::Request.new(handlers, context) end |
#create_named_query(params = {}) ⇒ Types::CreateNamedQueryOutput
Creates a named query.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
372 373 374 375 |
# File 'lib/aws-sdk-athena/client.rb', line 372 def create_named_query(params = {}, = {}) req = build_request(:create_named_query, params) req.send_request() end |
#delete_named_query(params = {}) ⇒ Struct
Deletes a named query.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
404 405 406 407 |
# File 'lib/aws-sdk-athena/client.rb', line 404 def delete_named_query(params = {}, = {}) req = build_request(:delete_named_query, params) req.send_request() end |
#get_named_query(params = {}) ⇒ Types::GetNamedQueryOutput
Returns information about a single query.
436 437 438 439 |
# File 'lib/aws-sdk-athena/client.rb', line 436 def get_named_query(params = {}, = {}) req = build_request(:get_named_query, params) req.send_request() end |
#get_query_execution(params = {}) ⇒ Types::GetQueryExecutionOutput
Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.
478 479 480 481 |
# File 'lib/aws-sdk-athena/client.rb', line 478 def get_query_execution(params = {}, = {}) req = build_request(:get_query_execution, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
Returns the results of a single query execution specified by ‘QueryExecutionId`. This request does not execute the query but returns results. Use StartQueryExecution to run a query.
534 535 536 537 |
# File 'lib/aws-sdk-athena/client.rb', line 534 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#list_named_queries(params = {}) ⇒ Types::ListNamedQueriesOutput
Provides a list of all available query IDs.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
577 578 579 580 |
# File 'lib/aws-sdk-athena/client.rb', line 577 def list_named_queries(params = {}, = {}) req = build_request(:list_named_queries, params) req.send_request() end |
#list_query_executions(params = {}) ⇒ Types::ListQueryExecutionsOutput
Provides a list of all available query execution IDs.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
620 621 622 623 |
# File 'lib/aws-sdk-athena/client.rb', line 620 def list_query_executions(params = {}, = {}) req = build_request(:list_query_executions, params) req.send_request() end |
#start_query_execution(params = {}) ⇒ Types::StartQueryExecutionOutput
Runs (executes) the SQL query statements contained in the ‘Query` string.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
689 690 691 692 |
# File 'lib/aws-sdk-athena/client.rb', line 689 def start_query_execution(params = {}, = {}) req = build_request(:start_query_execution, params) req.send_request() end |
#stop_query_execution(params = {}) ⇒ Struct
Stops a query execution.
For code samples using the AWS SDK for Java, see [Examples and Code Samples] in the *Amazon Athena User Guide*.
721 722 723 724 |
# File 'lib/aws-sdk-athena/client.rb', line 721 def stop_query_execution(params = {}, = {}) req = build_request(:stop_query_execution, 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.
745 746 747 |
# File 'lib/aws-sdk-athena/client.rb', line 745 def waiter_names [] end |