Struct rusoto_athena::AthenaClient

pub struct AthenaClient { /* private fields */ }

A client for the Amazon Athena API.

Implementations

impl AthenaClient

pub fn new(region: Region) -> AthenaClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> AthenaClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> AthenaClient

Trait Implementations

impl Athena for AthenaClient

fn batch_get_named_query<'life0, 'async_trait>(
    &'life0 self,
    input: BatchGetNamedQueryInput
) -> Pin<Box<dyn Future<Output = Result<BatchGetNamedQueryOutput, RusotoError<BatchGetNamedQueryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn batch_get_query_execution<'life0, 'async_trait>(
    &'life0 self,
    input: BatchGetQueryExecutionInput
) -> Pin<Box<dyn Future<Output = Result<BatchGetQueryExecutionOutput, RusotoError<BatchGetQueryExecutionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn create_data_catalog<'life0, 'async_trait>(
    &'life0 self,
    input: CreateDataCatalogInput
) -> Pin<Box<dyn Future<Output = Result<CreateDataCatalogOutput, RusotoError<CreateDataCatalogError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same AWS account.

fn create_named_query<'life0, 'async_trait>(
    &'life0 self,
    input: CreateNamedQueryInput
) -> Pin<Box<dyn Future<Output = Result<CreateNamedQueryOutput, RusotoError<CreateNamedQueryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn create_prepared_statement<'life0, 'async_trait>(
    &'life0 self,
    input: CreatePreparedStatementInput
) -> Pin<Box<dyn Future<Output = Result<CreatePreparedStatementOutput, RusotoError<CreatePreparedStatementError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a prepared statement for use with SQL queries in Athena.

fn create_work_group<'life0, 'async_trait>(
    &'life0 self,
    input: CreateWorkGroupInput
) -> Pin<Box<dyn Future<Output = Result<CreateWorkGroupOutput, RusotoError<CreateWorkGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Creates a workgroup with the specified name.

fn delete_data_catalog<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteDataCatalogInput
) -> Pin<Box<dyn Future<Output = Result<DeleteDataCatalogOutput, RusotoError<DeleteDataCatalogError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes a data catalog.

fn delete_named_query<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteNamedQueryInput
) -> Pin<Box<dyn Future<Output = Result<DeleteNamedQueryOutput, RusotoError<DeleteNamedQueryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn delete_prepared_statement<'life0, 'async_trait>(
    &'life0 self,
    input: DeletePreparedStatementInput
) -> Pin<Box<dyn Future<Output = Result<DeletePreparedStatementOutput, RusotoError<DeletePreparedStatementError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the prepared statement with the specified name from the specified workgroup.

fn delete_work_group<'life0, 'async_trait>(
    &'life0 self,
    input: DeleteWorkGroupInput
) -> Pin<Box<dyn Future<Output = Result<DeleteWorkGroupOutput, RusotoError<DeleteWorkGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

fn get_data_catalog<'life0, 'async_trait>(
    &'life0 self,
    input: GetDataCatalogInput
) -> Pin<Box<dyn Future<Output = Result<GetDataCatalogOutput, RusotoError<GetDataCatalogError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the specified data catalog.

fn get_database<'life0, 'async_trait>(
    &'life0 self,
    input: GetDatabaseInput
) -> Pin<Box<dyn Future<Output = Result<GetDatabaseOutput, RusotoError<GetDatabaseError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a database object for the specified database and data catalog.

fn get_named_query<'life0, 'async_trait>(
    &'life0 self,
    input: GetNamedQueryInput
) -> Pin<Box<dyn Future<Output = Result<GetNamedQueryOutput, RusotoError<GetNamedQueryError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

fn get_prepared_statement<'life0, 'async_trait>(
    &'life0 self,
    input: GetPreparedStatementInput
) -> Pin<Box<dyn Future<Output = Result<GetPreparedStatementOutput, RusotoError<GetPreparedStatementError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Retrieves the prepared statement with the specified name from the specified workgroup.

fn get_query_execution<'life0, 'async_trait>(
    &'life0 self,
    input: GetQueryExecutionInput
) -> Pin<Box<dyn Future<Output = Result<GetQueryExecutionOutput, RusotoError<GetQueryExecutionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn get_query_results<'life0, 'async_trait>(
    &'life0 self,
    input: GetQueryResultsInput
) -> Pin<Box<dyn Future<Output = Result<GetQueryResultsOutput, RusotoError<GetQueryResultsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn get_table_metadata<'life0, 'async_trait>(
    &'life0 self,
    input: GetTableMetadataInput
) -> Pin<Box<dyn Future<Output = Result<GetTableMetadataOutput, RusotoError<GetTableMetadataError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns table metadata for the specified catalog, database, and table.

fn get_work_group<'life0, 'async_trait>(
    &'life0 self,
    input: GetWorkGroupInput
) -> Pin<Box<dyn Future<Output = Result<GetWorkGroupOutput, RusotoError<GetWorkGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns information about the workgroup with the specified name.

fn list_data_catalogs<'life0, 'async_trait>(
    &'life0 self,
    input: ListDataCatalogsInput
) -> Pin<Box<dyn Future<Output = Result<ListDataCatalogsOutput, RusotoError<ListDataCatalogsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the data catalogs in the current AWS account.

fn list_databases<'life0, 'async_trait>(
    &'life0 self,
    input: ListDatabasesInput
) -> Pin<Box<dyn Future<Output = Result<ListDatabasesOutput, RusotoError<ListDatabasesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the databases in the specified data catalog.

fn list_engine_versions<'life0, 'async_trait>(
    &'life0 self,
    input: ListEngineVersionsInput
) -> Pin<Box<dyn Future<Output = Result<ListEngineVersionsOutput, RusotoError<ListEngineVersionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns a list of engine versions that are available to choose from, including the Auto option.

fn list_named_queries<'life0, 'async_trait>(
    &'life0 self,
    input: ListNamedQueriesInput
) -> Pin<Box<dyn Future<Output = Result<ListNamedQueriesOutput, RusotoError<ListNamedQueriesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn list_prepared_statements<'life0, 'async_trait>(
    &'life0 self,
    input: ListPreparedStatementsInput
) -> Pin<Box<dyn Future<Output = Result<ListPreparedStatementsOutput, RusotoError<ListPreparedStatementsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the prepared statements in the specfied workgroup.

fn list_query_executions<'life0, 'async_trait>(
    &'life0 self,
    input: ListQueryExecutionsInput
) -> Pin<Box<dyn Future<Output = Result<ListQueryExecutionsOutput, RusotoError<ListQueryExecutionsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn list_table_metadata<'life0, 'async_trait>(
    &'life0 self,
    input: ListTableMetadataInput
) -> Pin<Box<dyn Future<Output = Result<ListTableMetadataOutput, RusotoError<ListTableMetadataError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the metadata for the tables in the specified data catalog database.

fn list_tags_for_resource<'life0, 'async_trait>(
    &'life0 self,
    input: ListTagsForResourceInput
) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceOutput, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists the tags associated with an Athena workgroup or data catalog resource.

fn list_work_groups<'life0, 'async_trait>(
    &'life0 self,
    input: ListWorkGroupsInput
) -> Pin<Box<dyn Future<Output = Result<ListWorkGroupsOutput, RusotoError<ListWorkGroupsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Lists available workgroups for the account.

fn start_query_execution<'life0, 'async_trait>(
    &'life0 self,
    input: StartQueryExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StartQueryExecutionOutput, RusotoError<StartQueryExecutionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn stop_query_execution<'life0, 'async_trait>(
    &'life0 self,
    input: StopQueryExecutionInput
) -> Pin<Box<dyn Future<Output = Result<StopQueryExecutionOutput, RusotoError<StopQueryExecutionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn tag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<TagResourceOutput, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

fn untag_resource<'life0, 'async_trait>(
    &'life0 self,
    input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<UntagResourceOutput, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes one or more tags from a data catalog or workgroup resource.

fn update_data_catalog<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateDataCatalogInput
) -> Pin<Box<dyn Future<Output = Result<UpdateDataCatalogOutput, RusotoError<UpdateDataCatalogError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the data catalog that has the specified name.

fn update_prepared_statement<'life0, 'async_trait>(
    &'life0 self,
    input: UpdatePreparedStatementInput
) -> Pin<Box<dyn Future<Output = Result<UpdatePreparedStatementOutput, RusotoError<UpdatePreparedStatementError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates a prepared statement.

fn update_work_group<'life0, 'async_trait>(
    &'life0 self,
    input: UpdateWorkGroupInput
) -> Pin<Box<dyn Future<Output = Result<UpdateWorkGroupOutput, RusotoError<UpdateWorkGroupError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the workgroup with the specified name. The workgroup's name cannot be changed.

impl Clone for AthenaClient

fn clone(&self) -> AthenaClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.