Chilkat Online Tools

ListJobs TCL Example

AWS Batch

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 "batch"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://batch.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "batch.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 "arrayJobId" "string"
CkJsonObject_UpdateString $json "filters[0].name" "string"
CkJsonObject_UpdateString $json "filters[0].values[0]" "string"
CkJsonObject_UpdateString $json "jobQueue" "string"
CkJsonObject_UpdateString $json "jobStatus" "string"
CkJsonObject_UpdateInt $json "maxResults" 123
CkJsonObject_UpdateString $json "multiNodeJobId" "string"
CkJsonObject_UpdateString $json "nextToken" "string"

# The JSON request body created by the above code:

# {
#   "arrayJobId": "string",
#   "filters": [
#     {
#       "name": "string",
#       "values": [
#         "string"
#       ]
#     }
#   ],
#   "jobQueue": "string",
#   "jobStatus": "string",
#   "maxResults": number,
#   "multiNodeJobId": "string",
#   "nextToken": "string"
# }

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

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/v1/listjobs" $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 nextToken [CkJsonObject_stringOf $jResp "nextToken"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "jobSummaryList"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Index [CkJsonObject_IntOf $jResp "jobSummaryList[i].arrayProperties.index"]
    set Size [CkJsonObject_IntOf $jResp "jobSummaryList[i].arrayProperties.size"]
    set ExitCode [CkJsonObject_IntOf $jResp "jobSummaryList[i].container.exitCode"]
    set Reason [CkJsonObject_stringOf $jResp "jobSummaryList[i].container.reason"]
    set createdAt [CkJsonObject_IntOf $jResp "jobSummaryList[i].createdAt"]
    set jobArn [CkJsonObject_stringOf $jResp "jobSummaryList[i].jobArn"]
    set jobDefinition [CkJsonObject_stringOf $jResp "jobSummaryList[i].jobDefinition"]
    set jobId [CkJsonObject_stringOf $jResp "jobSummaryList[i].jobId"]
    set jobName [CkJsonObject_stringOf $jResp "jobSummaryList[i].jobName"]
    set IsMainNode [CkJsonObject_IntOf $jResp "jobSummaryList[i].nodeProperties.isMainNode"]
    set NodeIndex [CkJsonObject_IntOf $jResp "jobSummaryList[i].nodeProperties.nodeIndex"]
    set NumNodes [CkJsonObject_IntOf $jResp "jobSummaryList[i].nodeProperties.numNodes"]
    set startedAt [CkJsonObject_IntOf $jResp "jobSummaryList[i].startedAt"]
    set status [CkJsonObject_stringOf $jResp "jobSummaryList[i].status"]
    set statusReason [CkJsonObject_stringOf $jResp "jobSummaryList[i].statusReason"]
    set stoppedAt [CkJsonObject_IntOf $jResp "jobSummaryList[i].stoppedAt"]
    set i [expr $i + 1]
}

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

# {
#   "jobSummaryList": [
#     {
#       "arrayProperties": {
#         "index": number,
#         "size": number
#       },
#       "container": {
#         "exitCode": number,
#         "reason": "string"
#       },
#       "createdAt": number,
#       "jobArn": "string",
#       "jobDefinition": "string",
#       "jobId": "string",
#       "jobName": "string",
#       "nodeProperties": {
#         "isMainNode": boolean,
#         "nodeIndex": number,
#         "numNodes": number
#       },
#       "startedAt": number,
#       "status": "string",
#       "statusReason": "string",
#       "stoppedAt": number
#     }
#   ],
#   "nextToken": "string"
# }

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