DescribeAssessmentRuns PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "inspector")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://inspector.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"inspector.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"assessmentRunArns[0]","string")
; The JSON request body created by the above code:
; {
; "assessmentRunArns": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","InspectorService.DescribeAssessmentRuns")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
arn.s
assessmentTemplateArn.s
completedAt.i
createdAt.i
dataCollected.i
durationInSeconds.i
v_String.i
name.s
startedAt.i
state.s
stateChangedAt.i
j.i
count_j.i
date.i
error.i
v_event.s
message.s
snsPublishStatusCode.s
snsTopicArn.s
strVal.s
key.s
value.s
FailureCode.s = CkJsonObject::ckStringOf(jResp,"failedItems.string.failureCode")
Retryable.i = CkJsonObject::ckIntOf(jResp,"failedItems.string.retryable")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"assessmentRuns")
While i < count_i
CkJsonObject::setCkI(jResp, i)
arn = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].arn")
assessmentTemplateArn = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].assessmentTemplateArn")
completedAt = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].completedAt")
createdAt = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].createdAt")
dataCollected = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].dataCollected")
durationInSeconds = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].durationInSeconds")
v_String = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].findingCounts.string")
name = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].name")
startedAt = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].startedAt")
state = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].state")
stateChangedAt = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].stateChangedAt")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"assessmentRuns[i].notifications")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
date = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].notifications[j].date")
error = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].notifications[j].error")
v_event = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].notifications[j].event")
message = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].notifications[j].message")
snsPublishStatusCode = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].notifications[j].snsPublishStatusCode")
snsTopicArn = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].notifications[j].snsTopicArn")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"assessmentRuns[i].rulesPackageArns")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].rulesPackageArns[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"assessmentRuns[i].stateChanges")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
state = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].stateChanges[j].state")
stateChangedAt = CkJsonObject::ckIntOf(jResp,"assessmentRuns[i].stateChanges[j].stateChangedAt")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"assessmentRuns[i].userAttributesForFindings")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
key = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].userAttributesForFindings[j].key")
value = CkJsonObject::ckStringOf(jResp,"assessmentRuns[i].userAttributesForFindings[j].value")
j = j + 1
Wend
i = i + 1
Wend
; 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
; }
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
