AptlyStar

Athena

Run SQL queries on data in Amazon S3 using AWS Athena

Instructions d'utilisation

Integrate AWS Athena into workflows. Execute SQL queries against data in S3, check query status, retrieve results, manage named queries, and list executions. Requires AWS access key and secret access key.

Outils

athena_start_query

Start an SQL query execution in AWS Athena

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
queryStringstringOuiSQL query string to execute
databasestringNonDatabase name within the catalog
catalogstringNonData catalog name (default: AwsDataCatalog)
outputLocationstringNonS3 output location for query results (e.g., s3://bucket/path/)
workGroupstringNonWorkgroup to execute the query in (default: primary)

Sortie

ParamètreTypeDescription
queryExecutionIdstringUnique ID of the started query execution

athena_get_query_execution

Get the status and details of an Athena query execution

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
queryExecutionIdstringOuiQuery execution ID to check

Sortie

ParamètreTypeDescription
queryExecutionIdstringQuery execution ID
querystringSQL query string
statestringQuery state (QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELLED)
stateChangeReasonstringReason for state change (e.g., error message)
statementTypestringStatement type (DDL, DML, UTILITY)
databasestringDatabase name
catalogstringData catalog name
workGroupstringWorkgroup name
submissionDateTimenumberQuery submission time (Unix epoch ms)
completionDateTimenumberQuery completion time (Unix epoch ms)
dataScannedInBytesnumberAmount of data scanned in bytes
engineExecutionTimeInMillisnumberEngine execution time in milliseconds
queryPlanningTimeInMillisnumberQuery planning time in milliseconds
queryQueueTimeInMillisnumberTime the query spent in queue in milliseconds
totalExecutionTimeInMillisnumberTotal execution time in milliseconds
outputLocationstringS3 location of query results

athena_get_query_results

Retrieve the results of a completed Athena query execution

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
queryExecutionIdstringOuiQuery execution ID to get results for
maxResultsnumberNonMaximum number of rows to return (1-999)
nextTokenstringNonPagination token from a previous request

Sortie

ParamètreTypeDescription
columnsarrayColumn metadata (name and type)
rowsarrayResult rows as key-value objects
nextTokenstringPagination token for next page of results
updateCountnumberNumber of rows affected (for INSERT/UPDATE statements)

athena_stop_query

Stop a running Athena query execution

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
queryExecutionIdstringOuiQuery execution ID to stop

Sortie

ParamètreTypeDescription
successbooleanWhether the query was successfully stopped

athena_list_query_executions

List recent Athena query execution IDs

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
workGroupstringNonWorkgroup to list executions for (default: primary)
maxResultsnumberNonMaximum number of results (0-50)
nextTokenstringNonPagination token from a previous request

Sortie

ParamètreTypeDescription
queryExecutionIdsarrayList of query execution IDs
nextTokenstringPagination token for next page

athena_create_named_query

Create a saved/named query in AWS Athena

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
namestringOuiName for the saved query
databasestringOuiDatabase the query runs against
queryStringstringOuiSQL query string to save
descriptionstringNonDescription of the named query
workGroupstringNonWorkgroup to create the named query in

Sortie

ParamètreTypeDescription
namedQueryIdstringID of the created named query

athena_get_named_query

Get details of a saved/named query in AWS Athena

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
namedQueryIdstringOuiNamed query ID to retrieve

Sortie

ParamètreTypeDescription
namedQueryIdstringNamed query ID
namestringName of the saved query
descriptionstringQuery description
databasestringDatabase the query runs against
queryStringstringSQL query string
workGroupstringWorkgroup name

athena_list_named_queries

List saved/named query IDs in AWS Athena

Entrée

ParamètreTypeObligatoireDescription
awsRegionstringOuiAWS region (e.g., us-east-1)
awsAccessKeyIdstringOuiAWS access key ID
awsSecretAccessKeystringOuiAWS secret access key
workGroupstringNonWorkgroup to list named queries for
maxResultsnumberNonMaximum number of results (0-50)
nextTokenstringNonPagination token from a previous request

Sortie

ParamètreTypeDescription
namedQueryIdsarrayList of named query IDs
nextTokenstringPagination token for next page

On this page