Chilkat Online Tools

DescribeAssessmentRuns TCL Example

Amazon Inspector

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

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

# The JSON request body created by the above code:

# {
#   "assessmentRunArns": [
#     "string"
#   ]
# }

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

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 FailureCode [CkJsonObject_stringOf $jResp "failedItems.string.failureCode"]
set Retryable [CkJsonObject_IntOf $jResp "failedItems.string.retryable"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "assessmentRuns"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set arn [CkJsonObject_stringOf $jResp "assessmentRuns[i].arn"]
    set assessmentTemplateArn [CkJsonObject_stringOf $jResp "assessmentRuns[i].assessmentTemplateArn"]
    set completedAt [CkJsonObject_IntOf $jResp "assessmentRuns[i].completedAt"]
    set createdAt [CkJsonObject_IntOf $jResp "assessmentRuns[i].createdAt"]
    set dataCollected [CkJsonObject_IntOf $jResp "assessmentRuns[i].dataCollected"]
    set durationInSeconds [CkJsonObject_IntOf $jResp "assessmentRuns[i].durationInSeconds"]
    set v_String [CkJsonObject_IntOf $jResp "assessmentRuns[i].findingCounts.string"]
    set name [CkJsonObject_stringOf $jResp "assessmentRuns[i].name"]
    set startedAt [CkJsonObject_IntOf $jResp "assessmentRuns[i].startedAt"]
    set state [CkJsonObject_stringOf $jResp "assessmentRuns[i].state"]
    set stateChangedAt [CkJsonObject_IntOf $jResp "assessmentRuns[i].stateChangedAt"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "assessmentRuns[i].notifications"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set date [CkJsonObject_IntOf $jResp "assessmentRuns[i].notifications[j].date"]
        set error [CkJsonObject_IntOf $jResp "assessmentRuns[i].notifications[j].error"]
        set v_event [CkJsonObject_stringOf $jResp "assessmentRuns[i].notifications[j].event"]
        set message [CkJsonObject_stringOf $jResp "assessmentRuns[i].notifications[j].message"]
        set snsPublishStatusCode [CkJsonObject_stringOf $jResp "assessmentRuns[i].notifications[j].snsPublishStatusCode"]
        set snsTopicArn [CkJsonObject_stringOf $jResp "assessmentRuns[i].notifications[j].snsTopicArn"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "assessmentRuns[i].rulesPackageArns"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "assessmentRuns[i].rulesPackageArns[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "assessmentRuns[i].stateChanges"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set state [CkJsonObject_stringOf $jResp "assessmentRuns[i].stateChanges[j].state"]
        set stateChangedAt [CkJsonObject_IntOf $jResp "assessmentRuns[i].stateChanges[j].stateChangedAt"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "assessmentRuns[i].userAttributesForFindings"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set key [CkJsonObject_stringOf $jResp "assessmentRuns[i].userAttributesForFindings[j].key"]
        set value [CkJsonObject_stringOf $jResp "assessmentRuns[i].userAttributesForFindings[j].value"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "assessmentRuns": [
#     {
#       "arn": "string",
#       "assessmentTemplateArn": "string",
#       "completedAt": number,
#       "createdAt": number,
#       "dataCollected": boolean,
#       "durationInSeconds": number,
#       "findingCounts": {
#         "string": number
#       },
#       "name": "string",
#       "notifications": [
#         {
#           "date": number,
#           "error": boolean,
#           "event": "string",
#           "message": "string",
#           "snsPublishStatusCode": "string",
#           "snsTopicArn": "string"
#         }
#       ],
#       "rulesPackageArns": [
#         "string"
#       ],
#       "startedAt": number,
#       "state": "string",
#       "stateChangedAt": number,
#       "stateChanges": [
#         {
#           "state": "string",
#           "stateChangedAt": number
#         }
#       ],
#       "userAttributesForFindings": [
#         {
#           "key": "string",
#           "value": "string"
#         }
#       ]
#     }
#   ],
#   "failedItems": {
#     "string": {
#       "failureCode": "string",
#       "retryable": boolean
#     }
#   }
# }

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