athena: Amazon Athena

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

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.

Usage

1
athena(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- athena(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_get_named_query Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings
batch_get_query_execution Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings
create_data_catalog Creates (registers) a data catalog with the specified name and properties
create_named_query Creates a named query in the specified workgroup
create_work_group Creates a workgroup with the specified name
delete_data_catalog Deletes a data catalog
delete_named_query Deletes the named query if you have access to the workgroup in which the query was saved
delete_work_group Deletes the workgroup with the specified name
get_database Returns a database object for the specfied database and data catalog
get_data_catalog Returns the specified data catalog
get_named_query Returns information about a single query
get_query_execution Returns information about a single execution of a query if you have access to the workgroup in which the query ran
get_query_results Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3
get_table_metadata Returns table metadata for the specified catalog, database, and table
get_work_group Returns information about the workgroup with the specified name
list_databases Lists the databases in the specified data catalog
list_data_catalogs Lists the data catalogs in the current AWS account
list_named_queries Provides a list of available query IDs only for queries saved in the specified workgroup
list_query_executions Provides a list of available query execution IDs for the queries in the specified workgroup
list_table_metadata Lists the metadata for the tables in the specified data catalog database
list_tags_for_resource Lists the tags associated with an Athena workgroup or data catalog resource
list_work_groups Lists available workgroups for the account
start_query_execution Runs the SQL query statements contained in the Query
stop_query_execution Stops a query execution
tag_resource Adds one or more tags to an Athena resource
untag_resource Removes one or more tags from a data catalog or workgroup resource
update_data_catalog Updates the data catalog that has the specified name
update_work_group Updates the workgroup with the specified name

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- athena()
svc$batch_get_named_query(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to athena in paws...