@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAthenaClient extends AmazonWebServiceClient implements AmazonAthena
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.
If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchGetNamedQueryResult |
batchGetNamedQuery(BatchGetNamedQueryRequest request)
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.
|
BatchGetQueryExecutionResult |
batchGetQueryExecution(BatchGetQueryExecutionRequest request)
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.
|
static AmazonAthenaClientBuilder |
builder() |
CreateNamedQueryResult |
createNamedQuery(CreateNamedQueryRequest request)
Creates a named query in the specified workgroup.
|
CreateWorkGroupResult |
createWorkGroup(CreateWorkGroupRequest request)
Creates a workgroup with the specified name.
|
DeleteNamedQueryResult |
deleteNamedQuery(DeleteNamedQueryRequest request)
Deletes the named query if you have access to the workgroup in which the query was saved.
|
DeleteWorkGroupResult |
deleteWorkGroup(DeleteWorkGroupRequest request)
Deletes the workgroup with the specified name.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetNamedQueryResult |
getNamedQuery(GetNamedQueryRequest request)
Returns information about a single query.
|
GetQueryExecutionResult |
getQueryExecution(GetQueryExecutionRequest request)
Returns information about a single execution of a query if you have access to the workgroup in which the query
ran.
|
GetQueryResultsResult |
getQueryResults(GetQueryResultsRequest request)
Returns the results of a single query execution specified by
QueryExecutionId if you have access to
the workgroup in which the query ran. |
GetWorkGroupResult |
getWorkGroup(GetWorkGroupRequest request)
Returns information about the workgroup with the specified name.
|
ListNamedQueriesResult |
listNamedQueries(ListNamedQueriesRequest request)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
ListQueryExecutionsResult |
listQueryExecutions(ListQueryExecutionsRequest request)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags associated with this workgroup.
|
ListWorkGroupsResult |
listWorkGroups(ListWorkGroupsRequest request)
Lists available workgroups for the account.
|
StartQueryExecutionResult |
startQueryExecution(StartQueryExecutionRequest request)
Runs the SQL query statements contained in the
Query. |
StopQueryExecutionResult |
stopQueryExecution(StopQueryExecutionRequest request)
Stops a query execution.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the resource, such as a workgroup.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the workgroup resource.
|
UpdateWorkGroupResult |
updateWorkGroup(UpdateWorkGroupRequest request)
Updates the workgroup with the specified name.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonAthenaClientBuilder builder()
public BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest request)
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.
batchGetNamedQuery in interface AmazonAthenabatchGetNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest request)
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.
batchGetQueryExecution in interface AmazonAthenabatchGetQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest request)
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
createNamedQuery in interface AmazonAthenacreateNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest request)
Creates a workgroup with the specified name.
createWorkGroup in interface AmazonAthenacreateWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest request)
Deletes the named query if you have access to the workgroup in which the query was saved.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
deleteNamedQuery in interface AmazonAthenadeleteNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest request)
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
deleteWorkGroup in interface AmazonAthenadeleteWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public GetNamedQueryResult getNamedQuery(GetNamedQueryRequest request)
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
getNamedQuery in interface AmazonAthenagetNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest request)
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.
getQueryExecution in interface AmazonAthenagetQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
Returns the results of a single query execution specified by QueryExecutionId if you have access to
the workgroup in which the query ran. This request does not execute the query but returns results. Use
StartQueryExecution to run a query.
getQueryResults in interface AmazonAthenagetQueryResultsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public GetWorkGroupResult getWorkGroup(GetWorkGroupRequest request)
Returns information about the workgroup with the specified name.
getWorkGroup in interface AmazonAthenagetWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest request)
Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listNamedQueries in interface AmazonAthenalistNamedQueriesRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest request)
Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listQueryExecutions in interface AmazonAthenalistQueryExecutionsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags associated with this workgroup.
listTagsForResource in interface AmazonAthenalistTagsForResourceRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.public ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest request)
Lists available workgroups for the account.
listWorkGroups in interface AmazonAthenalistWorkGroupsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest request)
Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup
in which the query ran.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
startQueryExecution in interface AmazonAthenastartQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.public StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest request)
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
stopQueryExecution in interface AmazonAthenastopQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You 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, separate them by commas.
tagResource in interface AmazonAthenatagResourceRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.
untagResource in interface AmazonAthenauntagResourceRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.public UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest request)
Updates the workgroup with the specified name. The workgroup's name cannot be changed.
updateWorkGroup in interface AmazonAthenaupdateWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonAthenarequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.