RegisterJobDefinition 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,"containerProperties.command[0]","string")
CkJsonObject::ckUpdateString(json,"containerProperties.environment[0].name","string")
CkJsonObject::ckUpdateString(json,"containerProperties.environment[0].value","string")
CkJsonObject::ckUpdateString(json,"containerProperties.executionRoleArn","string")
CkJsonObject::ckUpdateString(json,"containerProperties.fargatePlatformConfiguration.platformVersion","string")
CkJsonObject::ckUpdateString(json,"containerProperties.image","string")
CkJsonObject::ckUpdateString(json,"containerProperties.instanceType","string")
CkJsonObject::ckUpdateString(json,"containerProperties.jobRoleArn","string")
CkJsonObject::ckUpdateString(json,"containerProperties.linuxParameters.devices[0].containerPath","string")
CkJsonObject::ckUpdateString(json,"containerProperties.linuxParameters.devices[0].hostPath","string")
CkJsonObject::ckUpdateString(json,"containerProperties.linuxParameters.devices[0].permissions[0]","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.linuxParameters.initProcessEnabled",123)
CkJsonObject::ckUpdateInt(json,"containerProperties.linuxParameters.maxSwap",123)
CkJsonObject::ckUpdateInt(json,"containerProperties.linuxParameters.sharedMemorySize",123)
CkJsonObject::ckUpdateInt(json,"containerProperties.linuxParameters.swappiness",123)
CkJsonObject::ckUpdateString(json,"containerProperties.linuxParameters.tmpfs[0].containerPath","string")
CkJsonObject::ckUpdateString(json,"containerProperties.linuxParameters.tmpfs[0].mountOptions[0]","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.linuxParameters.tmpfs[0].size",123)
CkJsonObject::ckUpdateString(json,"containerProperties.logConfiguration.logDriver","string")
CkJsonObject::ckUpdateString(json,"containerProperties.logConfiguration.options.string","string")
CkJsonObject::ckUpdateString(json,"containerProperties.logConfiguration.secretOptions[0].name","string")
CkJsonObject::ckUpdateString(json,"containerProperties.logConfiguration.secretOptions[0].valueFrom","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.memory",123)
CkJsonObject::ckUpdateString(json,"containerProperties.mountPoints[0].containerPath","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.mountPoints[0].readOnly",123)
CkJsonObject::ckUpdateString(json,"containerProperties.mountPoints[0].sourceVolume","string")
CkJsonObject::ckUpdateString(json,"containerProperties.networkConfiguration.assignPublicIp","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.privileged",123)
CkJsonObject::ckUpdateInt(json,"containerProperties.readonlyRootFilesystem",123)
CkJsonObject::ckUpdateString(json,"containerProperties.resourceRequirements[0].type","string")
CkJsonObject::ckUpdateString(json,"containerProperties.resourceRequirements[0].value","string")
CkJsonObject::ckUpdateString(json,"containerProperties.secrets[0].name","string")
CkJsonObject::ckUpdateString(json,"containerProperties.secrets[0].valueFrom","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.ulimits[0].hardLimit",123)
CkJsonObject::ckUpdateString(json,"containerProperties.ulimits[0].name","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.ulimits[0].softLimit",123)
CkJsonObject::ckUpdateString(json,"containerProperties.user","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.vcpus",123)
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId","string")
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.iam","string")
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].efsVolumeConfiguration.fileSystemId","string")
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].efsVolumeConfiguration.rootDirectory","string")
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].efsVolumeConfiguration.transitEncryption","string")
CkJsonObject::ckUpdateInt(json,"containerProperties.volumes[0].efsVolumeConfiguration.transitEncryptionPort",123)
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].host.sourcePath","string")
CkJsonObject::ckUpdateString(json,"containerProperties.volumes[0].name","string")
CkJsonObject::ckUpdateString(json,"jobDefinitionName","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.mainNode",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.command[0]","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.environment[0].name","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.environment[0].value","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.executionRoleArn","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.fargatePlatformConfiguration.platformVersion","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.image","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.instanceType","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.jobRoleArn","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].containerPath","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].hostPath","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].permissions[0]","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.initProcessEnabled",123)
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.maxSwap",123)
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.sharedMemorySize",123)
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.swappiness",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].containerPath","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].mountOptions[0]","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].size",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.logConfiguration.logDriver","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.logConfiguration.options.string","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].name","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].valueFrom","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.memory",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.mountPoints[0].containerPath","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.mountPoints[0].readOnly",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.mountPoints[0].sourceVolume","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.networkConfiguration.assignPublicIp","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.privileged",123)
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.readonlyRootFilesystem",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].type","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].value","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.secrets[0].name","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.secrets[0].valueFrom","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.ulimits[0].hardLimit",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.ulimits[0].name","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.ulimits[0].softLimit",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.user","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.vcpus",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.iam","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.fileSystemId","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.rootDirectory","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryption","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryptionPort",123)
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].host.sourcePath","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].container.volumes[0].name","string")
CkJsonObject::ckUpdateString(json,"nodeProperties.nodeRangeProperties[0].targetNodes","string")
CkJsonObject::ckUpdateInt(json,"nodeProperties.numNodes",123)
CkJsonObject::ckUpdateString(json,"parameters.string","string")
CkJsonObject::ckUpdateString(json,"platformCapabilities[0]","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,"schedulingPriority",123)
CkJsonObject::ckUpdateString(json,"tags.string","string")
CkJsonObject::ckUpdateInt(json,"timeout.attemptDurationSeconds",123)
CkJsonObject::ckUpdateString(json,"type","string")
; The JSON request body created by the above code:
; {
; "containerProperties": {
; "command": [
; "string"
; ],
; "environment": [
; {
; "name": "string",
; "value": "string"
; }
; ],
; "executionRoleArn": "string",
; "fargatePlatformConfiguration": {
; "platformVersion": "string"
; },
; "image": "string",
; "instanceType": "string",
; "jobRoleArn": "string",
; "linuxParameters": {
; "devices": [
; {
; "containerPath": "string",
; "hostPath": "string",
; "permissions": [
; "string"
; ]
; }
; ],
; "initProcessEnabled": boolean,
; "maxSwap": number,
; "sharedMemorySize": number,
; "swappiness": number,
; "tmpfs": [
; {
; "containerPath": "string",
; "mountOptions": [
; "string"
; ],
; "size": number
; }
; ]
; },
; "logConfiguration": {
; "logDriver": "string",
; "options": {
; "string": "string"
; },
; "secretOptions": [
; {
; "name": "string",
; "valueFrom": "string"
; }
; ]
; },
; "memory": number,
; "mountPoints": [
; {
; "containerPath": "string",
; "readOnly": boolean,
; "sourceVolume": "string"
; }
; ],
; "networkConfiguration": {
; "assignPublicIp": "string"
; },
; "privileged": boolean,
; "readonlyRootFilesystem": boolean,
; "resourceRequirements": [
; {
; "type": "string",
; "value": "string"
; }
; ],
; "secrets": [
; {
; "name": "string",
; "valueFrom": "string"
; }
; ],
; "ulimits": [
; {
; "hardLimit": number,
; "name": "string",
; "softLimit": number
; }
; ],
; "user": "string",
; "vcpus": number,
; "volumes": [
; {
; "efsVolumeConfiguration": {
; "authorizationConfig": {
; "accessPointId": "string",
; "iam": "string"
; },
; "fileSystemId": "string",
; "rootDirectory": "string",
; "transitEncryption": "string",
; "transitEncryptionPort": number
; },
; "host": {
; "sourcePath": "string"
; },
; "name": "string"
; }
; ]
; },
; "jobDefinitionName": "string",
; "nodeProperties": {
; "mainNode": number,
; "nodeRangeProperties": [
; {
; "container": {
; "command": [
; "string"
; ],
; "environment": [
; {
; "name": "string",
; "value": "string"
; }
; ],
; "executionRoleArn": "string",
; "fargatePlatformConfiguration": {
; "platformVersion": "string"
; },
; "image": "string",
; "instanceType": "string",
; "jobRoleArn": "string",
; "linuxParameters": {
; "devices": [
; {
; "containerPath": "string",
; "hostPath": "string",
; "permissions": [
; "string"
; ]
; }
; ],
; "initProcessEnabled": boolean,
; "maxSwap": number,
; "sharedMemorySize": number,
; "swappiness": number,
; "tmpfs": [
; {
; "containerPath": "string",
; "mountOptions": [
; "string"
; ],
; "size": number
; }
; ]
; },
; "logConfiguration": {
; "logDriver": "string",
; "options": {
; "string": "string"
; },
; "secretOptions": [
; {
; "name": "string",
; "valueFrom": "string"
; }
; ]
; },
; "memory": number,
; "mountPoints": [
; {
; "containerPath": "string",
; "readOnly": boolean,
; "sourceVolume": "string"
; }
; ],
; "networkConfiguration": {
; "assignPublicIp": "string"
; },
; "privileged": boolean,
; "readonlyRootFilesystem": boolean,
; "resourceRequirements": [
; {
; "type": "string",
; "value": "string"
; }
; ],
; "secrets": [
; {
; "name": "string",
; "valueFrom": "string"
; }
; ],
; "ulimits": [
; {
; "hardLimit": number,
; "name": "string",
; "softLimit": number
; }
; ],
; "user": "string",
; "vcpus": number,
; "volumes": [
; {
; "efsVolumeConfiguration": {
; "authorizationConfig": {
; "accessPointId": "string",
; "iam": "string"
; },
; "fileSystemId": "string",
; "rootDirectory": "string",
; "transitEncryption": "string",
; "transitEncryptionPort": number
; },
; "host": {
; "sourcePath": "string"
; },
; "name": "string"
; }
; ]
; },
; "targetNodes": "string"
; }
; ],
; "numNodes": number
; },
; "parameters": {
; "string": "string"
; },
; "platformCapabilities": [
; "string"
; ],
; "propagateTags": boolean,
; "retryStrategy": {
; "attempts": number,
; "evaluateOnExit": [
; {
; "action": "string",
; "onExitCode": "string",
; "onReason": "string",
; "onStatusReason": "string"
; }
; ]
; },
; "schedulingPriority": number,
; "tags": {
; "string": "string"
; },
; "timeout": {
; "attemptDurationSeconds": number
; },
; "type": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","RegisterJobDefinition")
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/registerjobdefinition",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
jobDefinitionArn.s = CkJsonObject::ckStringOf(jResp,"jobDefinitionArn")
jobDefinitionName.s = CkJsonObject::ckStringOf(jResp,"jobDefinitionName")
revision.i = CkJsonObject::ckIntOf(jResp,"revision")
; A sample JSON response body parsed by the above code:
; {
; "jobDefinitionArn": "string",
; "jobDefinitionName": "string",
; "revision": number
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
