RegisterJobDefinition TCL Example
load ./chilkat.dll
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set rest [new_CkRest]
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "batch"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://batch.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "batch.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
exit
}
# 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
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "containerProperties.command[0]" "string"
CkJsonObject_UpdateString $json "containerProperties.environment[0].name" "string"
CkJsonObject_UpdateString $json "containerProperties.environment[0].value" "string"
CkJsonObject_UpdateString $json "containerProperties.executionRoleArn" "string"
CkJsonObject_UpdateString $json "containerProperties.fargatePlatformConfiguration.platformVersion" "string"
CkJsonObject_UpdateString $json "containerProperties.image" "string"
CkJsonObject_UpdateString $json "containerProperties.instanceType" "string"
CkJsonObject_UpdateString $json "containerProperties.jobRoleArn" "string"
CkJsonObject_UpdateString $json "containerProperties.linuxParameters.devices[0].containerPath" "string"
CkJsonObject_UpdateString $json "containerProperties.linuxParameters.devices[0].hostPath" "string"
CkJsonObject_UpdateString $json "containerProperties.linuxParameters.devices[0].permissions[0]" "string"
CkJsonObject_UpdateInt $json "containerProperties.linuxParameters.initProcessEnabled" 123
CkJsonObject_UpdateInt $json "containerProperties.linuxParameters.maxSwap" 123
CkJsonObject_UpdateInt $json "containerProperties.linuxParameters.sharedMemorySize" 123
CkJsonObject_UpdateInt $json "containerProperties.linuxParameters.swappiness" 123
CkJsonObject_UpdateString $json "containerProperties.linuxParameters.tmpfs[0].containerPath" "string"
CkJsonObject_UpdateString $json "containerProperties.linuxParameters.tmpfs[0].mountOptions[0]" "string"
CkJsonObject_UpdateInt $json "containerProperties.linuxParameters.tmpfs[0].size" 123
CkJsonObject_UpdateString $json "containerProperties.logConfiguration.logDriver" "string"
CkJsonObject_UpdateString $json "containerProperties.logConfiguration.options.string" "string"
CkJsonObject_UpdateString $json "containerProperties.logConfiguration.secretOptions[0].name" "string"
CkJsonObject_UpdateString $json "containerProperties.logConfiguration.secretOptions[0].valueFrom" "string"
CkJsonObject_UpdateInt $json "containerProperties.memory" 123
CkJsonObject_UpdateString $json "containerProperties.mountPoints[0].containerPath" "string"
CkJsonObject_UpdateInt $json "containerProperties.mountPoints[0].readOnly" 123
CkJsonObject_UpdateString $json "containerProperties.mountPoints[0].sourceVolume" "string"
CkJsonObject_UpdateString $json "containerProperties.networkConfiguration.assignPublicIp" "string"
CkJsonObject_UpdateInt $json "containerProperties.privileged" 123
CkJsonObject_UpdateInt $json "containerProperties.readonlyRootFilesystem" 123
CkJsonObject_UpdateString $json "containerProperties.resourceRequirements[0].type" "string"
CkJsonObject_UpdateString $json "containerProperties.resourceRequirements[0].value" "string"
CkJsonObject_UpdateString $json "containerProperties.secrets[0].name" "string"
CkJsonObject_UpdateString $json "containerProperties.secrets[0].valueFrom" "string"
CkJsonObject_UpdateInt $json "containerProperties.ulimits[0].hardLimit" 123
CkJsonObject_UpdateString $json "containerProperties.ulimits[0].name" "string"
CkJsonObject_UpdateInt $json "containerProperties.ulimits[0].softLimit" 123
CkJsonObject_UpdateString $json "containerProperties.user" "string"
CkJsonObject_UpdateInt $json "containerProperties.vcpus" 123
CkJsonObject_UpdateString $json "containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId" "string"
CkJsonObject_UpdateString $json "containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.iam" "string"
CkJsonObject_UpdateString $json "containerProperties.volumes[0].efsVolumeConfiguration.fileSystemId" "string"
CkJsonObject_UpdateString $json "containerProperties.volumes[0].efsVolumeConfiguration.rootDirectory" "string"
CkJsonObject_UpdateString $json "containerProperties.volumes[0].efsVolumeConfiguration.transitEncryption" "string"
CkJsonObject_UpdateInt $json "containerProperties.volumes[0].efsVolumeConfiguration.transitEncryptionPort" 123
CkJsonObject_UpdateString $json "containerProperties.volumes[0].host.sourcePath" "string"
CkJsonObject_UpdateString $json "containerProperties.volumes[0].name" "string"
CkJsonObject_UpdateString $json "jobDefinitionName" "string"
CkJsonObject_UpdateInt $json "nodeProperties.mainNode" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.command[0]" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.environment[0].name" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.environment[0].value" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.executionRoleArn" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.fargatePlatformConfiguration.platformVersion" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.image" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.instanceType" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.jobRoleArn" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].containerPath" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].hostPath" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].permissions[0]" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.initProcessEnabled" 123
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.maxSwap" 123
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.sharedMemorySize" 123
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.swappiness" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].containerPath" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].mountOptions[0]" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].size" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.logConfiguration.logDriver" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.logConfiguration.options.string" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].name" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].valueFrom" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.memory" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.mountPoints[0].containerPath" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.mountPoints[0].readOnly" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.mountPoints[0].sourceVolume" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.networkConfiguration.assignPublicIp" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.privileged" 123
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.readonlyRootFilesystem" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].type" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].value" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.secrets[0].name" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.secrets[0].valueFrom" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.ulimits[0].hardLimit" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.ulimits[0].name" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.ulimits[0].softLimit" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.user" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.vcpus" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.iam" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.fileSystemId" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.rootDirectory" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryption" "string"
CkJsonObject_UpdateInt $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryptionPort" 123
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].host.sourcePath" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].container.volumes[0].name" "string"
CkJsonObject_UpdateString $json "nodeProperties.nodeRangeProperties[0].targetNodes" "string"
CkJsonObject_UpdateInt $json "nodeProperties.numNodes" 123
CkJsonObject_UpdateString $json "parameters.string" "string"
CkJsonObject_UpdateString $json "platformCapabilities[0]" "string"
CkJsonObject_UpdateInt $json "propagateTags" 123
CkJsonObject_UpdateInt $json "retryStrategy.attempts" 123
CkJsonObject_UpdateString $json "retryStrategy.evaluateOnExit[0].action" "string"
CkJsonObject_UpdateString $json "retryStrategy.evaluateOnExit[0].onExitCode" "string"
CkJsonObject_UpdateString $json "retryStrategy.evaluateOnExit[0].onReason" "string"
CkJsonObject_UpdateString $json "retryStrategy.evaluateOnExit[0].onStatusReason" "string"
CkJsonObject_UpdateInt $json "schedulingPriority" 123
CkJsonObject_UpdateString $json "tags.string" "string"
CkJsonObject_UpdateInt $json "timeout.attemptDurationSeconds" 123
CkJsonObject_UpdateString $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_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "RegisterJobDefinition"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/v1/registerjobdefinition" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
puts "Response Header:"
puts [CkRest_responseHeader $rest]
puts "Response Body:"
puts [CkStringBuilder_getAsString $sbResponseBody]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $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
set jobDefinitionArn [CkJsonObject_stringOf $jResp "jobDefinitionArn"]
set jobDefinitionName [CkJsonObject_stringOf $jResp "jobDefinitionName"]
set revision [CkJsonObject_IntOf $jResp "revision"]
# A sample JSON response body parsed by the above code:
# {
# "jobDefinitionArn": "string",
# "jobDefinitionName": "string",
# "revision": number
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
