AptlyStar

Athena

Run SQL queries on data in Amazon S3 using AWS Athena

Instrucciones de uso

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.

Herramientas

athena_start_query

Start an SQL query execution in AWS Athena

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
queryStringstringSíSQL query string to execute
databasestringNoDatabase name within the catalog
catalogstringNoData catalog name (default: AwsDataCatalog)
outputLocationstringNoS3 output location for query results (e.g., s3://bucket/path/)
workGroupstringNoWorkgroup to execute the query in (default: primary)

Salida

ParámetroTipoDescripción
queryExecutionIdstringUnique ID of the started query execution

athena_get_query_execution

Get the status and details of an Athena query execution

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
queryExecutionIdstringSíQuery execution ID to check

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
queryExecutionIdstringSíQuery execution ID to get results for
maxResultsnumberNoMaximum number of rows to return (1-999)
nextTokenstringNoPagination token from a previous request

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
queryExecutionIdstringSíQuery execution ID to stop

Salida

ParámetroTipoDescripción
successbooleanWhether the query was successfully stopped

athena_list_query_executions

List recent Athena query execution IDs

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
workGroupstringNoWorkgroup to list executions for (default: primary)
maxResultsnumberNoMaximum number of results (0-50)
nextTokenstringNoPagination token from a previous request

Salida

ParámetroTipoDescripción
queryExecutionIdsarrayList of query execution IDs
nextTokenstringPagination token for next page

athena_create_named_query

Create a saved/named query in AWS Athena

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
namestringSíName for the saved query
databasestringSíDatabase the query runs against
queryStringstringSíSQL query string to save
descriptionstringNoDescription of the named query
workGroupstringNoWorkgroup to create the named query in

Salida

ParámetroTipoDescripción
namedQueryIdstringID of the created named query

athena_get_named_query

Get details of a saved/named query in AWS Athena

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
namedQueryIdstringSíNamed query ID to retrieve

Salida

ParámetroTipoDescripción
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

Entrada

ParámetroTipoObligatorioDescripción
awsRegionstringSíAWS region (e.g., us-east-1)
awsAccessKeyIdstringSíAWS access key ID
awsSecretAccessKeystringSíAWS secret access key
workGroupstringNoWorkgroup to list named queries for
maxResultsnumberNoMaximum number of results (0-50)
nextTokenstringNoPagination token from a previous request

Salida

ParámetroTipoDescripción
namedQueryIdsarrayList of named query IDs
nextTokenstringPagination token for next page

On this page