SubmitJob 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::ckUpdateInt(json,"arrayProperties.size",123)
CkJsonObject::ckUpdateString(json,"containerOverrides.command[0]","string")
CkJsonObject::ckUpdateString(json,"containerOverrides.environment[0].name","string")
CkJsonObject::ckUpdateString(json,"containerOverrides.environment[0].value","string")
CkJsonObject::ckUpdateString(json,"containerOverrides.instanceType","string")
CkJsonObject::ckUpdateInt(json,"containerOverrides.memory",123)
CkJsonObject::ckUpdateString(json,"containerOverrides.resourceRequirements[0].type","string")
CkJsonObject::ckUpdateString(json,"containerOverrides.resourceRequirements[0].value","string")
CkJsonObject::ckUpdateInt(json,"containerOverrides.vcpus",123)
CkJsonObject::ckUpdateString(json,"dependsOn[0].jobId","string")
CkJsonObject::ckUpdateString(json,"dependsOn[0].type","string")
CkJsonObject::ckUpdateString(json,"jobDefinition","string")
CkJsonObject::ckUpdateString(json,"jobName","string")
CkJsonObject::ckUpdateString(json,"jobQueue","string")
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.command[0]","string")
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.environment[0].name","string")
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.environment[0].value","string")
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.instanceType","string")
CkJsonObject::ckUpdateInt(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.memory",123)
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.resourceRequirements[0].type","string")
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.resourceRequirements[0].value","string")
CkJsonObject::ckUpdateInt(json,"nodeOverrides.nodePropertyOverrides[0].containerOverrides.vcpus",123)
CkJsonObject::ckUpdateString(json,"nodeOverrides.nodePropertyOverrides[0].targetNodes","string")
CkJsonObject::ckUpdateInt(json,"nodeOverrides.numNodes",123)
CkJsonObject::ckUpdateString(json,"parameters.string","string")
CkJsonObject::ckUpdateInt(json,"propagateTags",123)
CkJsonObject::ckUpdateInt(json,"retryStrategy.attempts",123)
CkJsonObject::ckUpdateString(json,"retryStrategy.evaluateOnExit[0].action","string")
CkJsonObject::ckUpdateString(json,"retryStrategy.evaluateOnExit[0].onExitCode","string")
CkJsonObject::ckUpdateString(json,"retryStrategy.evaluateOnExit[0].onReason","string")
CkJsonObject::ckUpdateString(json,"retryStrategy.evaluateOnExit[0].onStatusReason","string")
CkJsonObject::ckUpdateInt(json,"schedulingPriorityOverride",123)
CkJsonObject::ckUpdateString(json,"shareIdentifier","string")
CkJsonObject::ckUpdateString(json,"tags.string","string")
CkJsonObject::ckUpdateInt(json,"timeout.attemptDurationSeconds",123)
; The JSON request body created by the above code:
; {
; "arrayProperties": {
; "size": number
; },
; "containerOverrides": {
; "command": [
; "string"
; ],
; "environment": [
; {
; "name": "string",
; "value": "string"
; }
; ],
; "instanceType": "string",
; "memory": number,
; "resourceRequirements": [
; {
; "type": "string",
; "value": "string"
; }
; ],
; "vcpus": number
; },
; "dependsOn": [
; {
; "jobId": "string",
; "type": "string"
; }
; ],
; "jobDefinition": "string",
; "jobName": "string",
; "jobQueue": "string",
; "nodeOverrides": {
; "nodePropertyOverrides": [
; {
; "containerOverrides": {
; "command": [
; "string"
; ],
; "environment": [
; {
; "name": "string",
; "value": "string"
; }
; ],
; "instanceType": "string",
; "memory": number,
; "resourceRequirements": [
; {
; "type": "string",
; "value": "string"
; }
; ],
; "vcpus": number
; },
; "targetNodes": "string"
; }
; ],
; "numNodes": number
; },
; "parameters": {
; "string": "string"
; },
; "propagateTags": boolean,
; "retryStrategy": {
; "attempts": number,
; "evaluateOnExit": [
; {
; "action": "string",
; "onExitCode": "string",
; "onReason": "string",
; "onStatusReason": "string"
; }
; ]
; },
; "schedulingPriorityOverride": number,
; "shareIdentifier": "string",
; "tags": {
; "string": "string"
; },
; "timeout": {
; "attemptDurationSeconds": number
; }
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","SubmitJob")
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/submitjob",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
jobArn.s = CkJsonObject::ckStringOf(jResp,"jobArn")
jobId.s = CkJsonObject::ckStringOf(jResp,"jobId")
jobName.s = CkJsonObject::ckStringOf(jResp,"jobName")
; A sample JSON response body parsed by the above code:
; {
; "jobArn": "string",
; "jobId": "string",
; "jobName": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure