Athena

Usage Instructions

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`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`queryString`	string	Yes	No description
`database`	string	No	No description
`catalog`	string	No	No description
`outputLocation`	string	No	No description
`workGroup`	string	No	No description

Output

Parameter	Type	Description
`queryExecutionId`	string	queryExecutionId output from the tool

`athena_get_query_execution`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`queryExecutionId`	string	Yes	No description

Output

Parameter	Type	Description
`queryExecutionId`	string	queryExecutionId output from the tool
`query`	string	query output from the tool
`state`	string	state output from the tool
`stateChangeReason`	string	stateChangeReason output from the tool
`statementType`	string	statementType output from the tool
`database`	string	database output from the tool
`catalog`	string	catalog output from the tool
`workGroup`	string	workGroup output from the tool
`submissionDateTime`	number	submissionDateTime output from the tool
`completionDateTime`	number	completionDateTime output from the tool
`dataScannedInBytes`	number	dataScannedInBytes output from the tool
`engineExecutionTimeInMillis`	number	engineExecutionTimeInMillis output from the tool
`queryPlanningTimeInMillis`	number	queryPlanningTimeInMillis output from the tool
`queryQueueTimeInMillis`	number	queryQueueTimeInMillis output from the tool
`totalExecutionTimeInMillis`	number	totalExecutionTimeInMillis output from the tool
`outputLocation`	string	outputLocation output from the tool

`athena_get_query_results`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`queryExecutionId`	string	Yes	No description
`maxResults`	number	No	No description
`nextToken`	string	No	No description

Output

Parameter	Type	Description
`columns`	array	columns output from the tool
`rows`	array	rows output from the tool
`nextToken`	string	nextToken output from the tool
`updateCount`	number	updateCount output from the tool

`athena_stop_query`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`queryExecutionId`	string	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	success output from the tool

`athena_list_query_executions`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`workGroup`	string	No	No description
`maxResults`	number	No	No description
`nextToken`	string	No	No description

Output

Parameter	Type	Description
`queryExecutionIds`	array	queryExecutionIds output from the tool
`nextToken`	string	nextToken output from the tool

`athena_create_named_query`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`name`	string	Yes	No description
`database`	string	Yes	No description
`queryString`	string	Yes	No description
`description`	string	No	No description
`workGroup`	string	No	No description

Output

Parameter	Type	Description
`namedQueryId`	string	namedQueryId output from the tool

`athena_get_named_query`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`namedQueryId`	string	Yes	No description

Output

Parameter	Type	Description
`namedQueryId`	string	namedQueryId output from the tool
`name`	string	name output from the tool
`description`	string	description output from the tool
`database`	string	database output from the tool
`queryString`	string	queryString output from the tool
`workGroup`	string	workGroup output from the tool

`athena_list_named_queries`

Input

Parameter	Type	Required	Description
`awsRegion`	string	Yes	No description
`awsAccessKeyId`	string	Yes	No description
`awsSecretAccessKey`	string	Yes	No description
`workGroup`	string	No	No description
`maxResults`	number	No	No description
`nextToken`	string	No	No description

Output

Parameter	Type	Description
`namedQueryIds`	array	namedQueryIds output from the tool
`nextToken`	string	nextToken output from the tool

Athena

本页内容