AptlyStar

Athena

Run SQL queries on data in Amazon S3 using AWS Athena

使用方法

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.

ツール

athena_start_query

Start an SQL query execution in AWS Athena

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
queryStringstringはいSQL query string to execute
databasestringいいえDatabase name within the catalog
catalogstringいいえData catalog name (default: AwsDataCatalog)
outputLocationstringいいえS3 output location for query results (e.g., s3://bucket/path/)
workGroupstringいいえWorkgroup to execute the query in (default: primary)

出力

パラメータ型説明
queryExecutionIdstringUnique ID of the started query execution

athena_get_query_execution

Get the status and details of an Athena query execution

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
queryExecutionIdstringはいQuery execution ID to check

出力

パラメータ型説明
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

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
queryExecutionIdstringはいQuery execution ID to get results for
maxResultsnumberいいえMaximum number of rows to return (1-999)
nextTokenstringいいえPagination token from a previous request

出力

パラメータ型説明
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

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
queryExecutionIdstringはいQuery execution ID to stop

出力

パラメータ型説明
successbooleanWhether the query was successfully stopped

athena_list_query_executions

List recent Athena query execution IDs

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
workGroupstringいいえWorkgroup to list executions for (default: primary)
maxResultsnumberいいえMaximum number of results (0-50)
nextTokenstringいいえPagination token from a previous request

出力

パラメータ型説明
queryExecutionIdsarrayList of query execution IDs
nextTokenstringPagination token for next page

athena_create_named_query

Create a saved/named query in AWS Athena

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
namestringはいName for the saved query
databasestringはいDatabase the query runs against
queryStringstringはいSQL query string to save
descriptionstringいいえDescription of the named query
workGroupstringいいえWorkgroup to create the named query in

出力

パラメータ型説明
namedQueryIdstringID of the created named query

athena_get_named_query

Get details of a saved/named query in AWS Athena

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
namedQueryIdstringはいNamed query ID to retrieve

出力

パラメータ型説明
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

入力

パラメータ型必須説明
awsRegionstringはいAWS region (e.g., us-east-1)
awsAccessKeyIdstringはいAWS access key ID
awsSecretAccessKeystringはいAWS secret access key
workGroupstringいいえWorkgroup to list named queries for
maxResultsnumberいいえMaximum number of results (0-50)
nextTokenstringいいえPagination token from a previous request

出力

パラメータ型説明
namedQueryIdsarrayList of named query IDs
nextTokenstringPagination token for next page

On this page