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

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`queryString`	string	是	SQL query string to execute
`database`	string	否	Database name within the catalog
`catalog`	string	否	Data catalog name (default: AwsDataCatalog)
`outputLocation`	string	否	S3 output location for query results (e.g., s3://bucket/path/)
`workGroup`	string	否	Workgroup to execute the query in (default: primary)

输出

参数	类型	描述
`queryExecutionId`	string	Unique ID of the started query execution

`athena_get_query_execution`

Get the status and details of an Athena query execution

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`queryExecutionId`	string	是	Query execution ID to check

输出

参数	类型	描述
`queryExecutionId`	string	Query execution ID
`query`	string	SQL query string
`state`	string	Query state (QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELLED)
`stateChangeReason`	string	Reason for state change (e.g., error message)
`statementType`	string	Statement type (DDL, DML, UTILITY)
`database`	string	Database name
`catalog`	string	Data catalog name
`workGroup`	string	Workgroup name
`submissionDateTime`	number	Query submission time (Unix epoch ms)
`completionDateTime`	number	Query completion time (Unix epoch ms)
`dataScannedInBytes`	number	Amount of data scanned in bytes
`engineExecutionTimeInMillis`	number	Engine execution time in milliseconds
`queryPlanningTimeInMillis`	number	Query planning time in milliseconds
`queryQueueTimeInMillis`	number	Time the query spent in queue in milliseconds
`totalExecutionTimeInMillis`	number	Total execution time in milliseconds
`outputLocation`	string	S3 location of query results

`athena_get_query_results`

Retrieve the results of a completed Athena query execution

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`queryExecutionId`	string	是	Query execution ID to get results for
`maxResults`	number	否	Maximum number of rows to return (1-999)
`nextToken`	string	否	Pagination token from a previous request

输出

参数	类型	描述
`columns`	array	Column metadata (name and type)
`rows`	array	Result rows as key-value objects
`nextToken`	string	Pagination token for next page of results
`updateCount`	number	Number of rows affected (for INSERT/UPDATE statements)

`athena_stop_query`

Stop a running Athena query execution

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`queryExecutionId`	string	是	Query execution ID to stop

输出

参数	类型	描述
`success`	boolean	Whether the query was successfully stopped

`athena_list_query_executions`

List recent Athena query execution IDs

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`workGroup`	string	否	Workgroup to list executions for (default: primary)
`maxResults`	number	否	Maximum number of results (0-50)
`nextToken`	string	否	Pagination token from a previous request

输出

参数	类型	描述
`queryExecutionIds`	array	List of query execution IDs
`nextToken`	string	Pagination token for next page

`athena_create_named_query`

Create a saved/named query in AWS Athena

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`name`	string	是	Name for the saved query
`database`	string	是	Database the query runs against
`queryString`	string	是	SQL query string to save
`description`	string	否	Description of the named query
`workGroup`	string	否	Workgroup to create the named query in

输出

参数	类型	描述
`namedQueryId`	string	ID of the created named query

`athena_get_named_query`

Get details of a saved/named query in AWS Athena

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`namedQueryId`	string	是	Named query ID to retrieve

输出

参数	类型	描述
`namedQueryId`	string	Named query ID
`name`	string	Name of the saved query
`description`	string	Query description
`database`	string	Database the query runs against
`queryString`	string	SQL query string
`workGroup`	string	Workgroup name

`athena_list_named_queries`

List saved/named query IDs in AWS Athena

输入

参数	类型	必填	描述
`awsRegion`	string	是	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	是	AWS access key ID
`awsSecretAccessKey`	string	是	AWS secret access key
`workGroup`	string	否	Workgroup to list named queries for
`maxResults`	number	否	Maximum number of results (0-50)
`nextToken`	string	否	Pagination token from a previous request

输出

参数	类型	描述
`namedQueryIds`	array	List of named query IDs
`nextToken`	string	Pagination token for next page

Athena

On this page