Chilkat Online Tools

GetQueryExecution TCL Example

Athena

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "athena"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://athena.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "athena.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# 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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "QueryExecutionId" "string"

# The JSON request body created by the above code:

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

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "AmazonAthena.GetQueryExecution"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $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

set EffectiveEngineVersion [CkJsonObject_stringOf $jResp "QueryExecution.EngineVersion.EffectiveEngineVersion"]
set SelectedEngineVersion [CkJsonObject_stringOf $jResp "QueryExecution.EngineVersion.SelectedEngineVersion"]
set Query [CkJsonObject_stringOf $jResp "QueryExecution.Query"]
set Catalog [CkJsonObject_stringOf $jResp "QueryExecution.QueryExecutionContext.Catalog"]
set Database [CkJsonObject_stringOf $jResp "QueryExecution.QueryExecutionContext.Database"]
set QueryExecutionId [CkJsonObject_stringOf $jResp "QueryExecution.QueryExecutionId"]
set S3AclOption [CkJsonObject_stringOf $jResp "QueryExecution.ResultConfiguration.AclConfiguration.S3AclOption"]
set EncryptionOption [CkJsonObject_stringOf $jResp "QueryExecution.ResultConfiguration.EncryptionConfiguration.EncryptionOption"]
set KmsKey [CkJsonObject_stringOf $jResp "QueryExecution.ResultConfiguration.EncryptionConfiguration.KmsKey"]
set ExpectedBucketOwner [CkJsonObject_stringOf $jResp "QueryExecution.ResultConfiguration.ExpectedBucketOwner"]
set OutputLocation [CkJsonObject_stringOf $jResp "QueryExecution.ResultConfiguration.OutputLocation"]
set StatementType [CkJsonObject_stringOf $jResp "QueryExecution.StatementType"]
set DataManifestLocation [CkJsonObject_stringOf $jResp "QueryExecution.Statistics.DataManifestLocation"]
set DataScannedInBytes [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.DataScannedInBytes"]
set EngineExecutionTimeInMillis [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.EngineExecutionTimeInMillis"]
set QueryPlanningTimeInMillis [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.QueryPlanningTimeInMillis"]
set QueryQueueTimeInMillis [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.QueryQueueTimeInMillis"]
set ServiceProcessingTimeInMillis [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.ServiceProcessingTimeInMillis"]
set TotalExecutionTimeInMillis [CkJsonObject_IntOf $jResp "QueryExecution.Statistics.TotalExecutionTimeInMillis"]
set ErrorCategory [CkJsonObject_IntOf $jResp "QueryExecution.Status.AthenaError.ErrorCategory"]
set ErrorMessage [CkJsonObject_stringOf $jResp "QueryExecution.Status.AthenaError.ErrorMessage"]
set ErrorType [CkJsonObject_IntOf $jResp "QueryExecution.Status.AthenaError.ErrorType"]
set Retryable [CkJsonObject_IntOf $jResp "QueryExecution.Status.AthenaError.Retryable"]
set CompletionDateTime [CkJsonObject_IntOf $jResp "QueryExecution.Status.CompletionDateTime"]
set State [CkJsonObject_stringOf $jResp "QueryExecution.Status.State"]
set StateChangeReason [CkJsonObject_stringOf $jResp "QueryExecution.Status.StateChangeReason"]
set SubmissionDateTime [CkJsonObject_IntOf $jResp "QueryExecution.Status.SubmissionDateTime"]
set WorkGroup [CkJsonObject_stringOf $jResp "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"
#   }
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp