Amazon AWS Athena

this connector allows turbine to execute queries on aws athena asset setup this integration authenticates with aws athena using the following input values requirements aws access key id a long term aws access key id with access to athena aws secret key id a long term secret access key associated with the above accesskey id region name the aws region role arn an arn of an aws iam role to assume this is optional external id an external id to use when assuming the role this is optional obtaining aws credentials to use this integration, you will need to have an aws account and obtain the necessary aws credentials you can obtain these credentials by following the steps below log in to your aws account and navigate to the iam console in the left navigation pane, click on the "users" tab and select the user for which you want to create credentials click on the "security credentials" tab, and then click on the "create access key" make sure to save the access key id and secret access key in a secure location, as you will not be able to see the secret access key again after this step if you want to use an aws iam role, you will need to have the arn of the role and an optional external id, if one was specified by the aws account administrator notes https //docs aws amazon com/powershell/latest/userguide/pstools appendix sign up html https //boto3 amazonaws com/v1/documentation/api/latest/reference/services/athena html#athena configurations asset authenticates using aws credentials configuration parameters parameter description type required aws access key id a specific long term aws access key id string required aws secret access key a specific long term aws secret access key string required region name the aws region where you want to create new connections string required role arn role arn string optional external id external id string optional aws session token session token string optional actions get query execution details returns information about a single execution of a query if you have access to the workgroup in which the query ran input argument name type required description queryexecutionid string required unique identifier input example {"queryexecutionid" "string"} output parameter type description queryexecution object output field queryexecution queryexecution engineversion object output field queryexecution engineversion queryexecution engineversion effectiveengineversion string output field queryexecution engineversion effectiveengineversion queryexecution engineversion selectedengineversion string output field queryexecution engineversion selectedengineversion queryexecution query string output field queryexecution query queryexecution queryexecutioncontext object output field queryexecution queryexecutioncontext queryexecution queryexecutionid string unique identifier queryexecution resultconfiguration object result of the operation queryexecution resultconfiguration outputlocation string result of the operation queryexecution resultreuseconfiguration object result of the operation queryexecution resultreuseconfiguration resultreusebyageconfiguration object result of the operation queryexecution resultreuseconfiguration resultreusebyageconfiguration enabled boolean result of the operation queryexecution statementtype string type of the resource queryexecution statistics object output field queryexecution statistics queryexecution statistics datascannedinbytes number response data queryexecution statistics engineexecutiontimeinmillis number output field queryexecution statistics engineexecutiontimeinmillis queryexecution statistics queryplanningtimeinmillis number output field queryexecution statistics queryplanningtimeinmillis queryexecution statistics queryqueuetimeinmillis number output field queryexecution statistics queryqueuetimeinmillis queryexecution statistics resultreuseinformation object result of the operation queryexecution statistics resultreuseinformation reusedpreviousresult boolean result of the operation queryexecution statistics serviceprocessingtimeinmillis number output field queryexecution statistics serviceprocessingtimeinmillis queryexecution statistics totalexecutiontimeinmillis number output field queryexecution statistics totalexecutiontimeinmillis queryexecution status object status value queryexecution status completiondatetime string status value queryexecution status state string status value output example {"queryexecution" {"engineversion" {"effectiveengineversion" "athena engine version 3","selectedengineversion" "auto"},"query" "select from \\"amazon security lake glue db us east 1\\" \\"amazon security lake tab ","queryexecutioncontext" {},"queryexecutionid" "777fd206 3500 4e05 8d8a ab46e13b44e3","resultconfiguration" {"outputlocation" "s3 //sif athena query results us east 1/some/777fd206 3500 4e05 8d8a ab46e13b44e "},"resultreuseconfiguration" {"resultreusebyageconfiguration" {}},"stateme get query results get results of a single query execution specified by queryexecutionid from the athena query results location in amazon s3 input argument name type required description queryexecutionid string required the unique id of the query execution nexttoken string optional a token generated by the athena service that specifies where to continue pagination if a previous request was truncated to obtain the next set of pages, pass in the nexttoken from the response object of the previous page call maxresults number optional the maximum number of results (rows) to return in this request input example {"queryexecutionid" "string","nexttoken" "string","maxresults" 123} output parameter type description responsemetadata object response data responsemetadata httpheaders object response data responsemetadata httpheaders connection string response data responsemetadata httpheaders content length string response data responsemetadata httpheaders content type string response data responsemetadata httpheaders date string response data responsemetadata httpheaders x amzn requestid string response data responsemetadata httpstatuscode number response data responsemetadata requestid string response data responsemetadata retryattempts number response data resultset object result of the operation resultset resultsetmetadata object response data resultset resultsetmetadata columninfo array response data resultset rows array result of the operation updatecount number count value nexttoken string output field nexttoken output example {"responsemetadata" {"httpheaders" {"connection" "keep alive","content length" "34116","content type" "application/x amz json 1 1","date" "wed, 06 sep 2023 16 14 05 gmt","x amzn requestid" "515cc1d7 ce9b 4679 97de beefcfb5bd75"},"httpstatuscode" 200,"requestid" "515cc1d7 ce9b 4679 97de beefcfb5bd75","retryattempts" 0},"resultset" {"resultsetmetadata" {"columninfo" \[]},"rows" \[{}]},"updatecount" 0} list query executions get a list of available query execution ids for the queries in the specified workgroup input argument name type required description workgroup string optional the name of the workgroup from which queries are being returned if a workgroup is not specified, a list of available query execution ids for the queries in the primary workgroup is returned nexttoken string optional a token generated by the athena service that specifies where to continue pagination if a previous request was truncated to obtain the next set of pages, pass in the nexttoken from the response object of the previous page call maxresults number optional the maximum number of query executions to return in this request input example {"workgroup" "string","nexttoken" "string","maxresults" 123} output parameter type description queryexecutionids array unique identifier responsemetadata object response data responsemetadata httpheaders object response data responsemetadata httpheaders connection string response data responsemetadata httpheaders content length string response data responsemetadata httpheaders content type string response data responsemetadata httpheaders date string response data responsemetadata httpheaders x amzn requestid string response data responsemetadata httpstatuscode number response data responsemetadata requestid string response data responsemetadata retryattempts number response data nexttoken string output field nexttoken output example {"queryexecutionids" \["aab18033 4d65 44b2 ad5c 5f8997d33a53","88998526 fff7 41d7 b113 9734dda00e65","777fd206 3500 4e05 8d8a ab46e13b44e3"],"responsemetadata" {"httpheaders" {"connection" "keep alive","content length" "257","content type" "application/x amz json 1 1","date" "wed, 06 sep 2023 16 11 29 gmt","x amzn requestid" "7bce08ab 4013 44ba 8a75 051800fc243c"},"httpstatuscode" 200,"requestid" "7bce08ab 4013 44ba 8a75 051800fc243c","retryattempts" 0}} start query execution runs the sql query statements and returns an execution id input argument name type required description querystring string required the sql query statements to be executed clientrequesttoken string optional a unique case sensitive string used to ensure the request to create the query is idempotent (executes only once) this parameter is autopopulated if not provided queryexecutioncontext object optional the database within which the query executes queryexecutioncontext database string optional the name of the database used in the query execution the database must exist in the catalog queryexecutioncontext catalog string optional the name of the data catalog used in the query execution resultconfiguration object optional specifies information about where and how to save the results of the query execution resultconfiguration outputlocation string optional the location in amazon s3 where your query and calculation results are stored, such as s3 //path/to/query/bucket/ resultconfiguration encryptionconfiguration object optional if query and calculation results are encrypted in amazon s3, indicates the encryption option used (for example, sse kms or cse kms) and key information resultconfiguration encryptionconfiguration encryptionoption string optional result of the operation resultconfiguration encryptionconfiguration kmskey string optional for sse kms and cse kms, this is the kms key arn or id resultconfiguration expectedbucketowner string optional result of the operation resultconfiguration aclconfiguration object optional indicates that an amazon s3 canned acl should be set to control ownership of stored query results resultconfiguration aclconfiguration s3acloption string optional the amazon s3 canned acl that athena should specify when storing query results workgroup string optional the name of the workgroup in which the query is being started executionparameters array optional a list of values for the parameters in a query the values are applied sequentially to the parameters in the query in the order in which the parameters occur resultreuseconfiguration object optional specifies the query result reuse behavior for the query resultreuseconfiguration resultreusebyageconfiguration object optional result of the operation resultreuseconfiguration resultreusebyageconfiguration enabled boolean optional result of the operation resultreuseconfiguration resultreusebyageconfiguration maxageinminutes number optional result of the operation input example {"querystring" "string","clientrequesttoken" "string","queryexecutioncontext" {"database" "string","catalog" "string"},"resultconfiguration" {"outputlocation" "string","encryptionconfiguration" {"encryptionoption" "string","kmskey" "string"},"expectedbucketowner" "string","aclconfiguration" {"s3acloption" "string"}},"workgroup" "string","executionparameters" \["string"],"resultreuseconfiguration" {"resultreusebyageconfiguration" {"enabled"\ true,"maxageinminutes" 60}}} output parameter type description queryexecutionid string unique identifier responsemetadata object response data responsemetadata httpheaders object response data responsemetadata httpheaders connection string response data responsemetadata httpheaders content length string response data responsemetadata httpheaders content type string response data responsemetadata httpheaders date string response data responsemetadata httpheaders x amzn requestid string response data responsemetadata httpstatuscode number response data responsemetadata requestid string response data responsemetadata retryattempts number response data output example {"queryexecutionid" "a437228e bd40 460f 9d1b a3f6be415920","responsemetadata" {"httpheaders" {"connection" "keep alive","content length" "59","content type" "application/x amz json 1 1","date" "wed, 06 sep 2023 16 24 19 gmt","x amzn requestid" "3b906e8b 4f70 428b 9369 49f0fcc3a0fc"},"httpstatuscode" 200,"requestid" "3b906e8b 4f70 428b 9369 49f0fcc3a0fc","retryattempts" 0}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt