Chilkat Online Tools

StopJob TCL Example

AWS Device Farm

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

# URL: https://devicefarm.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "devicefarm.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 "arn" "string"

# The JSON request body created by the above code:

# {
#   "arn": "string"
# }

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

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 Arn [CkJsonObject_stringOf $jResp "job.arn"]
set Errored [CkJsonObject_IntOf $jResp "job.counters.errored"]
set Failed [CkJsonObject_IntOf $jResp "job.counters.failed"]
set Passed [CkJsonObject_IntOf $jResp "job.counters.passed"]
set Skipped [CkJsonObject_IntOf $jResp "job.counters.skipped"]
set Stopped [CkJsonObject_IntOf $jResp "job.counters.stopped"]
set Total [CkJsonObject_IntOf $jResp "job.counters.total"]
set Warned [CkJsonObject_IntOf $jResp "job.counters.warned"]
set Created [CkJsonObject_IntOf $jResp "job.created"]
set DeviceArn [CkJsonObject_stringOf $jResp "job.device.arn"]
set Availability [CkJsonObject_stringOf $jResp "job.device.availability"]
set Carrier [CkJsonObject_stringOf $jResp "job.device.carrier"]
set Architecture [CkJsonObject_stringOf $jResp "job.device.cpu.architecture"]
set Clock [CkJsonObject_IntOf $jResp "job.device.cpu.clock"]
set Frequency [CkJsonObject_stringOf $jResp "job.device.cpu.frequency"]
set FleetName [CkJsonObject_stringOf $jResp "job.device.fleetName"]
set FleetType [CkJsonObject_stringOf $jResp "job.device.fleetType"]
set FormFactor [CkJsonObject_stringOf $jResp "job.device.formFactor"]
set HeapSize [CkJsonObject_IntOf $jResp "job.device.heapSize"]
set Image [CkJsonObject_stringOf $jResp "job.device.image"]
set Manufacturer [CkJsonObject_stringOf $jResp "job.device.manufacturer"]
set Memory [CkJsonObject_IntOf $jResp "job.device.memory"]
set Model [CkJsonObject_stringOf $jResp "job.device.model"]
set ModelId [CkJsonObject_stringOf $jResp "job.device.modelId"]
set Name [CkJsonObject_stringOf $jResp "job.device.name"]
set Os [CkJsonObject_stringOf $jResp "job.device.os"]
set Platform [CkJsonObject_stringOf $jResp "job.device.platform"]
set Radio [CkJsonObject_stringOf $jResp "job.device.radio"]
set RemoteAccessEnabled [CkJsonObject_IntOf $jResp "job.device.remoteAccessEnabled"]
set RemoteDebugEnabled [CkJsonObject_IntOf $jResp "job.device.remoteDebugEnabled"]
set Height [CkJsonObject_IntOf $jResp "job.device.resolution.height"]
set Width [CkJsonObject_IntOf $jResp "job.device.resolution.width"]
set Metered [CkJsonObject_IntOf $jResp "job.deviceMinutes.metered"]
set DeviceMinutesTotal [CkJsonObject_IntOf $jResp "job.deviceMinutes.total"]
set Unmetered [CkJsonObject_IntOf $jResp "job.deviceMinutes.unmetered"]
set InstanceArn [CkJsonObject_stringOf $jResp "job.instanceArn"]
set Message [CkJsonObject_stringOf $jResp "job.message"]
set jobName [CkJsonObject_stringOf $jResp "job.name"]
set Result [CkJsonObject_stringOf $jResp "job.result"]
set Started [CkJsonObject_IntOf $jResp "job.started"]
set Status [CkJsonObject_stringOf $jResp "job.status"]
set jobStopped [CkJsonObject_IntOf $jResp "job.stopped"]
set v_Type [CkJsonObject_stringOf $jResp "job.type"]
set VideoCapture [CkJsonObject_IntOf $jResp "job.videoCapture"]
set VideoEndpoint [CkJsonObject_stringOf $jResp "job.videoEndpoint"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "job.device.instances"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set arn [CkJsonObject_stringOf $jResp "job.device.instances[i].arn"]
    set deviceArn [CkJsonObject_stringOf $jResp "job.device.instances[i].deviceArn"]
    set instanceProfileArn [CkJsonObject_stringOf $jResp "job.device.instances[i].instanceProfile.arn"]
    set Description [CkJsonObject_stringOf $jResp "job.device.instances[i].instanceProfile.description"]
    set instanceProfileName [CkJsonObject_stringOf $jResp "job.device.instances[i].instanceProfile.name"]
    set PackageCleanup [CkJsonObject_IntOf $jResp "job.device.instances[i].instanceProfile.packageCleanup"]
    set RebootAfterUse [CkJsonObject_IntOf $jResp "job.device.instances[i].instanceProfile.rebootAfterUse"]
    set status [CkJsonObject_stringOf $jResp "job.device.instances[i].status"]
    set udid [CkJsonObject_stringOf $jResp "job.device.instances[i].udid"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "job.device.instances[i].instanceProfile.excludeAppPackagesFromCleanup"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "job.device.instances[i].instanceProfile.excludeAppPackagesFromCleanup[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "job.device.instances[i].labels"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "job.device.instances[i].labels[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "job": {
#     "arn": "string",
#     "counters": {
#       "errored": number,
#       "failed": number,
#       "passed": number,
#       "skipped": number,
#       "stopped": number,
#       "total": number,
#       "warned": number
#     },
#     "created": number,
#     "device": {
#       "arn": "string",
#       "availability": "string",
#       "carrier": "string",
#       "cpu": {
#         "architecture": "string",
#         "clock": number,
#         "frequency": "string"
#       },
#       "fleetName": "string",
#       "fleetType": "string",
#       "formFactor": "string",
#       "heapSize": number,
#       "image": "string",
#       "instances": [
#         {
#           "arn": "string",
#           "deviceArn": "string",
#           "instanceProfile": {
#             "arn": "string",
#             "description": "string",
#             "excludeAppPackagesFromCleanup": [
#               "string"
#             ],
#             "name": "string",
#             "packageCleanup": boolean,
#             "rebootAfterUse": boolean
#           },
#           "labels": [
#             "string"
#           ],
#           "status": "string",
#           "udid": "string"
#         }
#       ],
#       "manufacturer": "string",
#       "memory": number,
#       "model": "string",
#       "modelId": "string",
#       "name": "string",
#       "os": "string",
#       "platform": "string",
#       "radio": "string",
#       "remoteAccessEnabled": boolean,
#       "remoteDebugEnabled": boolean,
#       "resolution": {
#         "height": number,
#         "width": number
#       }
#     },
#     "deviceMinutes": {
#       "metered": number,
#       "total": number,
#       "unmetered": number
#     },
#     "instanceArn": "string",
#     "message": "string",
#     "name": "string",
#     "result": "string",
#     "started": number,
#     "status": "string",
#     "stopped": number,
#     "type": "string",
#     "videoCapture": boolean,
#     "videoEndpoint": "string"
#   }
# }

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