@Generated(value="software.amazon.awssdk:codegen") public interface AthenaClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGetNamedQueryResponse |
batchGetNamedQuery(BatchGetNamedQueryRequest 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.
|
default BatchGetNamedQueryResponse |
batchGetNamedQuery(Consumer<BatchGetNamedQueryRequest.Builder> 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.
|
default BatchGetQueryExecutionResponse |
batchGetQueryExecution(BatchGetQueryExecutionRequest 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.
|
default BatchGetQueryExecutionResponse |
batchGetQueryExecution(Consumer<BatchGetQueryExecutionRequest.Builder> 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.
|
static AthenaClientBuilder |
builder()
Create a builder that can be used to configure and create a
AthenaClient. |
static AthenaClient |
create()
Create a
AthenaClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDataCatalogResponse |
createDataCatalog(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest)
Creates (registers) a data catalog with the specified name and properties.
|
default CreateDataCatalogResponse |
createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)
Creates (registers) a data catalog with the specified name and properties.
|
default CreateNamedQueryResponse |
createNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest)
Creates a named query in the specified workgroup.
|
default CreateNamedQueryResponse |
createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)
Creates a named query in the specified workgroup.
|
default CreateWorkGroupResponse |
createWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest)
Creates a workgroup with the specified name.
|
default CreateWorkGroupResponse |
createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)
Creates a workgroup with the specified name.
|
default DeleteDataCatalogResponse |
deleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest)
Deletes a data catalog.
|
default DeleteDataCatalogResponse |
deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)
Deletes a data catalog.
|
default DeleteNamedQueryResponse |
deleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest)
Deletes the named query if you have access to the workgroup in which the query was saved.
|
default DeleteNamedQueryResponse |
deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)
Deletes the named query if you have access to the workgroup in which the query was saved.
|
default DeleteWorkGroupResponse |
deleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest)
Deletes the workgroup with the specified name.
|
default DeleteWorkGroupResponse |
deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)
Deletes the workgroup with the specified name.
|
default GetDatabaseResponse |
getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)
Returns a database object for the specfied database and data catalog.
|
default GetDatabaseResponse |
getDatabase(GetDatabaseRequest getDatabaseRequest)
Returns a database object for the specfied database and data catalog.
|
default GetDataCatalogResponse |
getDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest)
Returns the specified data catalog.
|
default GetDataCatalogResponse |
getDataCatalog(GetDataCatalogRequest getDataCatalogRequest)
Returns the specified data catalog.
|
default GetNamedQueryResponse |
getNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest)
Returns information about a single query.
|
default GetNamedQueryResponse |
getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)
Returns information about a single query.
|
default GetQueryExecutionResponse |
getQueryExecution(Consumer<GetQueryExecutionRequest.Builder> getQueryExecutionRequest)
Returns information about a single execution of a query if you have access to the workgroup in which the query
ran.
|
default GetQueryExecutionResponse |
getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)
Returns information about a single execution of a query if you have access to the workgroup in which the query
ran.
|
default GetQueryResultsResponse |
getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Streams the results of a single query execution specified by
QueryExecutionId from the Athena query
results location in Amazon S3. |
default GetQueryResultsResponse |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Streams the results of a single query execution specified by
QueryExecutionId from the Athena query
results location in Amazon S3. |
default GetQueryResultsIterable |
getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Streams the results of a single query execution specified by
QueryExecutionId from the Athena query
results location in Amazon S3. |
default GetQueryResultsIterable |
getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)
Streams the results of a single query execution specified by
QueryExecutionId from the Athena query
results location in Amazon S3. |
default GetTableMetadataResponse |
getTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest)
Returns table metadata for the specified catalog, database, and table.
|
default GetTableMetadataResponse |
getTableMetadata(GetTableMetadataRequest getTableMetadataRequest)
Returns table metadata for the specified catalog, database, and table.
|
default GetWorkGroupResponse |
getWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest)
Returns information about the workgroup with the specified name.
|
default GetWorkGroupResponse |
getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)
Returns information about the workgroup with the specified name.
|
default ListDatabasesResponse |
listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Lists the databases in the specified data catalog.
|
default ListDatabasesResponse |
listDatabases(ListDatabasesRequest listDatabasesRequest)
Lists the databases in the specified data catalog.
|
default ListDatabasesIterable |
listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Lists the databases in the specified data catalog.
|
default ListDatabasesIterable |
listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)
Lists the databases in the specified data catalog.
|
default ListDataCatalogsResponse |
listDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)
Lists the data catalogs in the current AWS account.
|
default ListDataCatalogsResponse |
listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest)
Lists the data catalogs in the current AWS account.
|
default ListDataCatalogsIterable |
listDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)
Lists the data catalogs in the current AWS account.
|
default ListDataCatalogsIterable |
listDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest)
Lists the data catalogs in the current AWS account.
|
default ListNamedQueriesResponse |
listNamedQueries()
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListNamedQueriesResponse |
listNamedQueries(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListNamedQueriesResponse |
listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListNamedQueriesIterable |
listNamedQueriesPaginator()
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListNamedQueriesIterable |
listNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListNamedQueriesIterable |
listNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
default ListQueryExecutionsResponse |
listQueryExecutions()
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListQueryExecutionsResponse |
listQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListQueryExecutionsResponse |
listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListQueryExecutionsIterable |
listQueryExecutionsPaginator()
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListQueryExecutionsIterable |
listQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListQueryExecutionsIterable |
listQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
default ListTableMetadataResponse |
listTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
|
default ListTableMetadataResponse |
listTableMetadata(ListTableMetadataRequest listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
|
default ListTableMetadataIterable |
listTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
|
default ListTableMetadataIterable |
listTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with an Athena workgroup or data catalog resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Athena workgroup or data catalog resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags associated with an Athena workgroup or data catalog resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Athena workgroup or data catalog resource.
|
default ListWorkGroupsResponse |
listWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)
Lists available workgroups for the account.
|
default ListWorkGroupsResponse |
listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)
Lists available workgroups for the account.
|
default ListWorkGroupsIterable |
listWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)
Lists available workgroups for the account.
|
default ListWorkGroupsIterable |
listWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest)
Lists available workgroups for the account.
|
static ServiceMetadata |
serviceMetadata() |
default StartQueryExecutionResponse |
startQueryExecution(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest)
Runs the SQL query statements contained in the
Query. |
default StartQueryExecutionResponse |
startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)
Runs the SQL query statements contained in the
Query. |
default StopQueryExecutionResponse |
stopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest)
Stops a query execution.
|
default StopQueryExecutionResponse |
stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)
Stops a query execution.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to an Athena resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to an Athena resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from a data catalog or workgroup resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a data catalog or workgroup resource.
|
default UpdateDataCatalogResponse |
updateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest)
Updates the data catalog that has the specified name.
|
default UpdateDataCatalogResponse |
updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)
Updates the data catalog that has the specified name.
|
default UpdateWorkGroupResponse |
updateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest)
Updates the workgroup with the specified name.
|
default UpdateWorkGroupResponse |
updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)
Updates the workgroup with the specified name.
|
serviceNameclosestatic final String SERVICE_NAME
static AthenaClient create()
AthenaClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AthenaClientBuilder builder()
AthenaClient.default BatchGetNamedQueryResponse batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
batchGetNamedQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetNamedQueryResponse batchGetNamedQuery(Consumer<BatchGetNamedQueryRequest.Builder> batchGetNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the BatchGetNamedQueryRequest.Builder avoiding the
need to create one manually via BatchGetNamedQueryRequest.builder()
batchGetNamedQueryRequest - A Consumer that will call methods on BatchGetNamedQueryInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetQueryExecutionResponse batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
batchGetQueryExecutionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetQueryExecutionResponse batchGetQueryExecution(Consumer<BatchGetQueryExecutionRequest.Builder> batchGetQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the BatchGetQueryExecutionRequest.Builder avoiding the
need to create one manually via BatchGetQueryExecutionRequest.builder()
batchGetQueryExecutionRequest - A Consumer that will call methods on BatchGetQueryExecutionInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataCatalogResponse createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same AWS account.
createDataCatalogRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataCatalogResponse createDataCatalog(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same AWS account.
This is a convenience which creates an instance of the CreateDataCatalogRequest.Builder avoiding the need
to create one manually via CreateDataCatalogRequest.builder()
createDataCatalogRequest - A Consumer that will call methods on CreateDataCatalogInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateNamedQueryResponse createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
createNamedQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateNamedQueryResponse createNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the CreateNamedQueryRequest.Builder avoiding the need
to create one manually via CreateNamedQueryRequest.builder()
createNamedQueryRequest - A Consumer that will call methods on CreateNamedQueryInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWorkGroupResponse createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a workgroup with the specified name.
createWorkGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWorkGroupResponse createWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a workgroup with the specified name.
This is a convenience which creates an instance of the CreateWorkGroupRequest.Builder avoiding the need
to create one manually via CreateWorkGroupRequest.builder()
createWorkGroupRequest - A Consumer that will call methods on CreateWorkGroupInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataCatalogResponse deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes a data catalog.
deleteDataCatalogRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataCatalogResponse deleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes a data catalog.
This is a convenience which creates an instance of the DeleteDataCatalogRequest.Builder avoiding the need
to create one manually via DeleteDataCatalogRequest.builder()
deleteDataCatalogRequest - A Consumer that will call methods on DeleteDataCatalogInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamedQueryResponse deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
deleteNamedQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamedQueryResponse deleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the DeleteNamedQueryRequest.Builder avoiding the need
to create one manually via DeleteNamedQueryRequest.builder()
deleteNamedQueryRequest - A Consumer that will call methods on DeleteNamedQueryInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWorkGroupResponse deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
deleteWorkGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWorkGroupResponse deleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
This is a convenience which creates an instance of the DeleteWorkGroupRequest.Builder avoiding the need
to create one manually via DeleteWorkGroupRequest.builder()
deleteWorkGroupRequest - A Consumer that will call methods on DeleteWorkGroupInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataCatalogResponse getDataCatalog(GetDataCatalogRequest getDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the specified data catalog.
getDataCatalogRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataCatalogResponse getDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the specified data catalog.
This is a convenience which creates an instance of the GetDataCatalogRequest.Builder avoiding the need to
create one manually via GetDataCatalogRequest.builder()
getDataCatalogRequest - A Consumer that will call methods on GetDataCatalogInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDatabaseResponse getDatabase(GetDatabaseRequest getDatabaseRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns a database object for the specfied database and data catalog.
getDatabaseRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDatabaseResponse getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns a database object for the specfied database and data catalog.
This is a convenience which creates an instance of the GetDatabaseRequest.Builder avoiding the need to
create one manually via GetDatabaseRequest.builder()
getDatabaseRequest - A Consumer that will call methods on GetDatabaseInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamedQueryResponse getNamedQuery(GetNamedQueryRequest getNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
getNamedQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamedQueryResponse getNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
This is a convenience which creates an instance of the GetNamedQueryRequest.Builder avoiding the need to
create one manually via GetNamedQueryRequest.builder()
getNamedQueryRequest - A Consumer that will call methods on GetNamedQueryInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryExecutionResponse getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
getQueryExecutionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryExecutionResponse getQueryExecution(Consumer<GetQueryExecutionRequest.Builder> getQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the GetQueryExecutionRequest.Builder avoiding the need
to create one manually via GetQueryExecutionRequest.builder()
getQueryExecutionRequest - A Consumer that will call methods on GetQueryExecutionInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see Query Results 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.
getQueryResultsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see Query Results 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.
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsIterable getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see Query Results 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.
This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client
.getQueryResultsPaginator(request);
for (software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation.
getQueryResultsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsIterable getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see Query Results 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.
This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client
.getQueryResultsPaginator(request);
for (software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation.
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableMetadataResponse getTableMetadata(GetTableMetadataRequest getTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns table metadata for the specified catalog, database, and table.
getTableMetadataRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableMetadataResponse getTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns table metadata for the specified catalog, database, and table.
This is a convenience which creates an instance of the GetTableMetadataRequest.Builder avoiding the need
to create one manually via GetTableMetadataRequest.builder()
getTableMetadataRequest - A Consumer that will call methods on GetTableMetadataInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkGroupResponse getWorkGroup(GetWorkGroupRequest getWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about the workgroup with the specified name.
getWorkGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkGroupResponse getWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about the workgroup with the specified name.
This is a convenience which creates an instance of the GetWorkGroupRequest.Builder avoiding the need to
create one manually via GetWorkGroupRequest.builder()
getWorkGroupRequest - A Consumer that will call methods on GetWorkGroupInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCatalogsResponse listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the data catalogs in the current AWS account.
listDataCatalogsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCatalogsResponse listDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the data catalogs in the current AWS account.
This is a convenience which creates an instance of the ListDataCatalogsRequest.Builder avoiding the need
to create one manually via ListDataCatalogsRequest.builder()
listDataCatalogsRequest - A Consumer that will call methods on ListDataCatalogsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCatalogsIterable listDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the data catalogs in the current AWS account.
This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client
.listDataCatalogsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation.
listDataCatalogsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCatalogsIterable listDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the data catalogs in the current AWS account.
This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client
.listDataCatalogsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation.
This is a convenience which creates an instance of the ListDataCatalogsRequest.Builder avoiding the need
to create one manually via ListDataCatalogsRequest.builder()
listDataCatalogsRequest - A Consumer that will call methods on ListDataCatalogsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatabasesResponse listDatabases(ListDatabasesRequest listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
listDatabasesRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatabasesResponse listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatabasesIterable listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
This is a variant of listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListDatabasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation.
listDatabasesRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatabasesIterable listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
This is a variant of listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListDatabasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation.
This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamedQueriesResponse listNamedQueries() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistNamedQueries(ListNamedQueriesRequest),
AWS API
Documentationdefault ListNamedQueriesResponse listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listNamedQueriesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamedQueriesResponse listNamedQueries(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a convenience which creates an instance of the ListNamedQueriesRequest.Builder avoiding the need
to create one manually via ListNamedQueriesRequest.builder()
listNamedQueriesRequest - A Consumer that will call methods on ListNamedQueriesInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamedQueriesIterable listNamedQueriesPaginator() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client
.listNamedQueriesPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistNamedQueriesPaginator(ListNamedQueriesRequest),
AWS API
Documentationdefault ListNamedQueriesIterable listNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client
.listNamedQueriesPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.
listNamedQueriesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamedQueriesIterable listNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client
.listNamedQueriesPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.
This is a convenience which creates an instance of the ListNamedQueriesRequest.Builder avoiding the need
to create one manually via ListNamedQueriesRequest.builder()
listNamedQueriesRequest - A Consumer that will call methods on ListNamedQueriesInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueryExecutionsResponse listQueryExecutions() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistQueryExecutions(ListQueryExecutionsRequest),
AWS API
Documentationdefault ListQueryExecutionsResponse listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listQueryExecutionsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueryExecutionsResponse listQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a convenience which creates an instance of the ListQueryExecutionsRequest.Builder avoiding the
need to create one manually via ListQueryExecutionsRequest.builder()
listQueryExecutionsRequest - A Consumer that will call methods on ListQueryExecutionsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueryExecutionsIterable listQueryExecutionsPaginator() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client
.listQueryExecutionsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistQueryExecutionsPaginator(ListQueryExecutionsRequest),
AWS API
Documentationdefault ListQueryExecutionsIterable listQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client
.listQueryExecutionsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.
listQueryExecutionsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueryExecutionsIterable listQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client
.listQueryExecutionsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListQueryExecutionsRequest.Builder avoiding the
need to create one manually via ListQueryExecutionsRequest.builder()
listQueryExecutionsRequest - A Consumer that will call methods on ListQueryExecutionsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableMetadataResponse listTableMetadata(ListTableMetadataRequest listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
listTableMetadataRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableMetadataResponse listTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
This is a convenience which creates an instance of the ListTableMetadataRequest.Builder avoiding the need
to create one manually via ListTableMetadataRequest.builder()
listTableMetadataRequest - A Consumer that will call methods on ListTableMetadataInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableMetadataIterable listTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client
.listTableMetadataPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation.
listTableMetadataRequest - 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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableMetadataIterable listTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client
.listTableMetadataPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation.
This is a convenience which creates an instance of the ListTableMetadataRequest.Builder avoiding the need
to create one manually via ListTableMetadataRequest.builder()
listTableMetadataRequest - A Consumer that will call methods on ListTableMetadataInput.Builder to create a request.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.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena workgroup or data catalog resource.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena workgroup or data catalog resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena workgroup or data catalog resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena workgroup or data catalog resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWorkGroupsResponse listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
listWorkGroupsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWorkGroupsResponse listWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
This is a convenience which creates an instance of the ListWorkGroupsRequest.Builder avoiding the need to
create one manually via ListWorkGroupsRequest.builder()
listWorkGroupsRequest - A Consumer that will call methods on ListWorkGroupsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWorkGroupsIterable listWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
This is a variant of listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation.
listWorkGroupsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWorkGroupsIterable listWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
This is a variant of listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
for (software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation.
This is a convenience which creates an instance of the ListWorkGroupsRequest.Builder avoiding the need to
create one manually via ListWorkGroupsRequest.builder()
listWorkGroupsRequest - A Consumer that will call methods on ListWorkGroupsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryExecutionResponse startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the
Amazon Athena User Guide.
startQueryExecutionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryExecutionResponse startQueryExecution(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
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 AWS SDK for Java, see Examples and Code Samples in the
Amazon Athena User Guide.
This is a convenience which creates an instance of the StartQueryExecutionRequest.Builder avoiding the
need to create one manually via StartQueryExecutionRequest.builder()
startQueryExecutionRequest - A Consumer that will call methods on StartQueryExecutionInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopQueryExecutionResponse stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
stopQueryExecutionRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopQueryExecutionResponse stopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.
This is a convenience which creates an instance of the StopQueryExecutionRequest.Builder avoiding the
need to create one manually via StopQueryExecutionRequest.builder()
stopQueryExecutionRequest - A Consumer that will call methods on StopQueryExecutionInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. 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 or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs 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.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. 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 or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Removes one or more tags from a data catalog or workgroup resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Removes one or more tags from a data catalog or workgroup resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataCatalogResponse updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the data catalog that has the specified name.
updateDataCatalogRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDataCatalogResponse updateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the data catalog that has the specified name.
This is a convenience which creates an instance of the UpdateDataCatalogRequest.Builder avoiding the need
to create one manually via UpdateDataCatalogRequest.builder()
updateDataCatalogRequest - A Consumer that will call methods on UpdateDataCatalogInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateWorkGroupResponse updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the workgroup with the specified name. The workgroup's name cannot be changed.
updateWorkGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateWorkGroupResponse updateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the workgroup with the specified name. The workgroup's name cannot be changed.
This is a convenience which creates an instance of the UpdateWorkGroupRequest.Builder avoiding the need
to create one manually via UpdateWorkGroupRequest.builder()
updateWorkGroupRequest - A Consumer that will call methods on UpdateWorkGroupInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AthenaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.