ListJobs 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, "batch")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://batch.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"batch.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,"arrayJobId","string")
CkJsonObject::ckUpdateString(json,"filters[0].name","string")
CkJsonObject::ckUpdateString(json,"filters[0].values[0]","string")
CkJsonObject::ckUpdateString(json,"jobQueue","string")
CkJsonObject::ckUpdateString(json,"jobStatus","string")
CkJsonObject::ckUpdateInt(json,"maxResults",123)
CkJsonObject::ckUpdateString(json,"multiNodeJobId","string")
CkJsonObject::ckUpdateString(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::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","ListJobs")
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","/v1/listjobs",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
Index.i
Size.i
ExitCode.i
Reason.s
createdAt.i
jobArn.s
jobDefinition.s
jobId.s
jobName.s
IsMainNode.i
NodeIndex.i
NumNodes.i
startedAt.i
status.s
statusReason.s
stoppedAt.i
nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"jobSummaryList")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Index = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].arrayProperties.index")
Size = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].arrayProperties.size")
ExitCode = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].container.exitCode")
Reason = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].container.reason")
createdAt = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].createdAt")
jobArn = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].jobArn")
jobDefinition = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].jobDefinition")
jobId = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].jobId")
jobName = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].jobName")
IsMainNode = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].nodeProperties.isMainNode")
NodeIndex = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].nodeProperties.nodeIndex")
NumNodes = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].nodeProperties.numNodes")
startedAt = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].startedAt")
status = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].status")
statusReason = CkJsonObject::ckStringOf(jResp,"jobSummaryList[i].statusReason")
stoppedAt = CkJsonObject::ckIntOf(jResp,"jobSummaryList[i].stoppedAt")
i = i + 1
Wend
; 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"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
