AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Athena Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Athena.AmazonAthenaClient

Namespace: Amazon.Athena
Assembly: AWSSDK.Athena.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAthenaClient : AmazonServiceClient
         IAmazonAthena, IAmazonService, IDisposable

The AmazonAthenaClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAthenaClient()

Constructs AmazonAthenaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAthenaClient(RegionEndpoint)

Constructs AmazonAthenaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAthenaClient(AmazonAthenaConfig)

Constructs AmazonAthenaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAthenaClient(AWSCredentials)

Constructs AmazonAthenaClient with AWS Credentials

Public Method AmazonAthenaClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAthenaClient with AWS Credentials

Public Method AmazonAthenaClient(AWSCredentials, AmazonAthenaConfig)

Constructs AmazonAthenaClient with AWS Credentials and an AmazonAthenaClient Configuration object.

Public Method AmazonAthenaClient(string, string)

Constructs AmazonAthenaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAthenaClient(string, string, RegionEndpoint)

Constructs AmazonAthenaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAthenaClient(string, string, AmazonAthenaConfig)

Constructs AmazonAthenaClient with AWS Access Key ID, AWS Secret Key and an AmazonAthenaClient Configuration object.

Public Method AmazonAthenaClient(string, string, string)

Constructs AmazonAthenaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAthenaClient(string, string, string, RegionEndpoint)

Constructs AmazonAthenaClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAthenaClient(string, string, string, AmazonAthenaConfig)

Constructs AmazonAthenaClient with AWS Access Key ID, AWS Secret Key and an AmazonAthenaClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchGetNamedQuery(BatchGetNamedQueryRequest)

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.

Public Method BatchGetNamedQueryAsync(BatchGetNamedQueryRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetNamedQuery operation.

Public Method BatchGetQueryExecution(BatchGetQueryExecutionRequest)

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.

Public Method BatchGetQueryExecutionAsync(BatchGetQueryExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the BatchGetQueryExecution operation.

Public Method CreateNamedQuery(CreateNamedQueryRequest)

Creates a named query.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Public Method CreateNamedQueryAsync(CreateNamedQueryRequest, CancellationToken)

Initiates the asynchronous execution of the CreateNamedQuery operation.

Public Method DeleteNamedQuery(DeleteNamedQueryRequest)

Deletes a named query.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Public Method DeleteNamedQueryAsync(DeleteNamedQueryRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNamedQuery operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetNamedQuery(GetNamedQueryRequest)

Returns information about a single query.

Public Method GetNamedQueryAsync(GetNamedQueryRequest, CancellationToken)

Initiates the asynchronous execution of the GetNamedQuery operation.

Public Method GetQueryExecution(GetQueryExecutionRequest)

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.

Public Method GetQueryExecutionAsync(GetQueryExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the GetQueryExecution operation.

Public Method GetQueryResults(GetQueryResultsRequest)

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.

Public Method GetQueryResultsAsync(GetQueryResultsRequest, CancellationToken)

Initiates the asynchronous execution of the GetQueryResults operation.

Public Method ListNamedQueries(ListNamedQueriesRequest)

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.

Public Method ListNamedQueriesAsync(ListNamedQueriesRequest, CancellationToken)

Initiates the asynchronous execution of the ListNamedQueries operation.

Public Method ListQueryExecutions(ListQueryExecutionsRequest)

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.

Public Method ListQueryExecutionsAsync(ListQueryExecutionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListQueryExecutions operation.

Public Method StartQueryExecution(StartQueryExecutionRequest)

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.

Public Method StartQueryExecutionAsync(StartQueryExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StartQueryExecution operation.

Public Method StopQueryExecution(StopQueryExecutionRequest)

Stops a query execution.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Public Method StopQueryExecutionAsync(StopQueryExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StopQueryExecution operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms