Chilkat Online Tools

GetQueryExecution Ruby Example

Athena

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")

# Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("athena")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://athena.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("athena.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

json = Chilkat::CkJsonObject.new()
json.UpdateString("QueryExecutionId","string")

# The JSON request body created by the above code:

# {
#   "QueryExecutionId": "string"
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","AmazonAthena.GetQueryExecution")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

EffectiveEngineVersion = jResp.stringOf("QueryExecution.EngineVersion.EffectiveEngineVersion")
SelectedEngineVersion = jResp.stringOf("QueryExecution.EngineVersion.SelectedEngineVersion")
Query = jResp.stringOf("QueryExecution.Query")
Catalog = jResp.stringOf("QueryExecution.QueryExecutionContext.Catalog")
Database = jResp.stringOf("QueryExecution.QueryExecutionContext.Database")
QueryExecutionId = jResp.stringOf("QueryExecution.QueryExecutionId")
S3AclOption = jResp.stringOf("QueryExecution.ResultConfiguration.AclConfiguration.S3AclOption")
EncryptionOption = jResp.stringOf("QueryExecution.ResultConfiguration.EncryptionConfiguration.EncryptionOption")
KmsKey = jResp.stringOf("QueryExecution.ResultConfiguration.EncryptionConfiguration.KmsKey")
ExpectedBucketOwner = jResp.stringOf("QueryExecution.ResultConfiguration.ExpectedBucketOwner")
OutputLocation = jResp.stringOf("QueryExecution.ResultConfiguration.OutputLocation")
StatementType = jResp.stringOf("QueryExecution.StatementType")
DataManifestLocation = jResp.stringOf("QueryExecution.Statistics.DataManifestLocation")
DataScannedInBytes = jResp.IntOf("QueryExecution.Statistics.DataScannedInBytes")
EngineExecutionTimeInMillis = jResp.IntOf("QueryExecution.Statistics.EngineExecutionTimeInMillis")
QueryPlanningTimeInMillis = jResp.IntOf("QueryExecution.Statistics.QueryPlanningTimeInMillis")
QueryQueueTimeInMillis = jResp.IntOf("QueryExecution.Statistics.QueryQueueTimeInMillis")
ServiceProcessingTimeInMillis = jResp.IntOf("QueryExecution.Statistics.ServiceProcessingTimeInMillis")
TotalExecutionTimeInMillis = jResp.IntOf("QueryExecution.Statistics.TotalExecutionTimeInMillis")
ErrorCategory = jResp.IntOf("QueryExecution.Status.AthenaError.ErrorCategory")
ErrorMessage = jResp.stringOf("QueryExecution.Status.AthenaError.ErrorMessage")
ErrorType = jResp.IntOf("QueryExecution.Status.AthenaError.ErrorType")
Retryable = jResp.IntOf("QueryExecution.Status.AthenaError.Retryable")
CompletionDateTime = jResp.IntOf("QueryExecution.Status.CompletionDateTime")
State = jResp.stringOf("QueryExecution.Status.State")
StateChangeReason = jResp.stringOf("QueryExecution.Status.StateChangeReason")
SubmissionDateTime = jResp.IntOf("QueryExecution.Status.SubmissionDateTime")
WorkGroup = jResp.stringOf("QueryExecution.WorkGroup")

# A sample JSON response body parsed by the above code:

# {
#   "QueryExecution": {
#     "EngineVersion": {
#       "EffectiveEngineVersion": "string",
#       "SelectedEngineVersion": "string"
#     },
#     "Query": "string",
#     "QueryExecutionContext": {
#       "Catalog": "string",
#       "Database": "string"
#     },
#     "QueryExecutionId": "string",
#     "ResultConfiguration": {
#       "AclConfiguration": {
#         "S3AclOption": "string"
#       },
#       "EncryptionConfiguration": {
#         "EncryptionOption": "string",
#         "KmsKey": "string"
#       },
#       "ExpectedBucketOwner": "string",
#       "OutputLocation": "string"
#     },
#     "StatementType": "string",
#     "Statistics": {
#       "DataManifestLocation": "string",
#       "DataScannedInBytes": number,
#       "EngineExecutionTimeInMillis": number,
#       "QueryPlanningTimeInMillis": number,
#       "QueryQueueTimeInMillis": number,
#       "ServiceProcessingTimeInMillis": number,
#       "TotalExecutionTimeInMillis": number
#     },
#     "Status": {
#       "AthenaError": {
#         "ErrorCategory": number,
#         "ErrorMessage": "string",
#         "ErrorType": number,
#         "Retryable": boolean
#       },
#       "CompletionDateTime": number,
#       "State": "string",
#       "StateChangeReason": "string",
#       "SubmissionDateTime": number
#     },
#     "WorkGroup": "string"
#   }
# }