DescribeJobs 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, "drs")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://drs.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"drs.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,"filters.fromDate","string")
CkJsonObject::ckUpdateString(json,"filters.jobIDs[0]","string")
CkJsonObject::ckUpdateString(json,"filters.toDate","string")
CkJsonObject::ckUpdateInt(json,"maxResults",123)
CkJsonObject::ckUpdateString(json,"nextToken","string")
; The JSON request body created by the above code:
; {
; "filters": {
; "fromDate": "string",
; "jobIDs": [
; "string"
; ],
; "toDate": "string"
; },
; "maxResults": number,
; "nextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeJobs")
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","/DescribeJobs",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
creationDateTime.s
endDateTime.s
initiatedBy.s
jobID.s
status.s
v_String.s
v_type.s
j.i
count_j.i
launchStatus.s
recoveryInstanceID.s
sourceServerID.s
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
arn = CkJsonObject::ckStringOf(jResp,"items[i].arn")
creationDateTime = CkJsonObject::ckStringOf(jResp,"items[i].creationDateTime")
endDateTime = CkJsonObject::ckStringOf(jResp,"items[i].endDateTime")
initiatedBy = CkJsonObject::ckStringOf(jResp,"items[i].initiatedBy")
jobID = CkJsonObject::ckStringOf(jResp,"items[i].jobID")
status = CkJsonObject::ckStringOf(jResp,"items[i].status")
v_String = CkJsonObject::ckStringOf(jResp,"items[i].tags.string")
v_type = CkJsonObject::ckStringOf(jResp,"items[i].type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"items[i].participatingServers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
launchStatus = CkJsonObject::ckStringOf(jResp,"items[i].participatingServers[j].launchStatus")
recoveryInstanceID = CkJsonObject::ckStringOf(jResp,"items[i].participatingServers[j].recoveryInstanceID")
sourceServerID = CkJsonObject::ckStringOf(jResp,"items[i].participatingServers[j].sourceServerID")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "items": [
; {
; "arn": "string",
; "creationDateTime": "string",
; "endDateTime": "string",
; "initiatedBy": "string",
; "jobID": "string",
; "participatingServers": [
; {
; "launchStatus": "string",
; "recoveryInstanceID": "string",
; "sourceServerID": "string"
; }
; ],
; "status": "string",
; "tags": {
; "string": "string"
; },
; "type": "string"
; }
; ],
; "nextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure