Athena

Nutzungsanweisungen

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.

Tools

`athena_start_query`

Start an SQL query execution in AWS Athena

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`queryString`	string	Ja	SQL query string to execute
`database`	string	Nein	Database name within the catalog
`catalog`	string	Nein	Data catalog name (default: AwsDataCatalog)
`outputLocation`	string	Nein	S3 output location for query results (e.g., s3://bucket/path/)
`workGroup`	string	Nein	Workgroup to execute the query in (default: primary)

Ausgabe

Parameter	Typ	Beschreibung
`queryExecutionId`	string	Unique ID of the started query execution

`athena_get_query_execution`

Get the status and details of an Athena query execution

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`queryExecutionId`	string	Ja	Query execution ID to check

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`queryExecutionId`	string	Ja	Query execution ID to get results for
`maxResults`	number	Nein	Maximum number of rows to return (1-999)
`nextToken`	string	Nein	Pagination token from a previous request

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`queryExecutionId`	string	Ja	Query execution ID to stop

Ausgabe

Parameter	Typ	Beschreibung
`success`	boolean	Whether the query was successfully stopped

`athena_list_query_executions`

List recent Athena query execution IDs

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`workGroup`	string	Nein	Workgroup to list executions for (default: primary)
`maxResults`	number	Nein	Maximum number of results (0-50)
`nextToken`	string	Nein	Pagination token from a previous request

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`name`	string	Ja	Name for the saved query
`database`	string	Ja	Database the query runs against
`queryString`	string	Ja	SQL query string to save
`description`	string	Nein	Description of the named query
`workGroup`	string	Nein	Workgroup to create the named query in

Ausgabe

Parameter	Typ	Beschreibung
`namedQueryId`	string	ID of the created named query

`athena_get_named_query`

Get details of a saved/named query in AWS Athena

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`namedQueryId`	string	Ja	Named query ID to retrieve

Ausgabe

Parameter	Typ	Beschreibung
`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

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
`awsRegion`	string	Ja	AWS region (e.g., us-east-1)
`awsAccessKeyId`	string	Ja	AWS access key ID
`awsSecretAccessKey`	string	Ja	AWS secret access key
`workGroup`	string	Nein	Workgroup to list named queries for
`maxResults`	number	Nein	Maximum number of results (0-50)
`nextToken`	string	Nein	Pagination token from a previous request

Ausgabe

Parameter	Typ	Beschreibung
`namedQueryIds`	array	List of named query IDs
`nextToken`	string	Pagination token for next page

Athena

On this page