RegisterJobDefinition Swift Example
func chilkatTest() {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let rest = CkoRest()
var success: Bool
let authAws = CkoAuthAws()
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "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.)
authAws.Region = "us-west-2"
authAws.ServiceName = "batch"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
// URL: https://batch.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = rest.Connect("batch.us-west-2.amazonaws.com", port: 443, tls: true, autoReconnect: true)
if success != true {
print("ConnectFailReason: \(rest.ConnectFailReason.intValue)")
print("\(rest.LastErrorText)")
return
}
// 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
let json = CkoJsonObject()
json.UpdateString("containerProperties.command[0]", value: "string")
json.UpdateString("containerProperties.environment[0].name", value: "string")
json.UpdateString("containerProperties.environment[0].value", value: "string")
json.UpdateString("containerProperties.executionRoleArn", value: "string")
json.UpdateString("containerProperties.fargatePlatformConfiguration.platformVersion", value: "string")
json.UpdateString("containerProperties.image", value: "string")
json.UpdateString("containerProperties.instanceType", value: "string")
json.UpdateString("containerProperties.jobRoleArn", value: "string")
json.UpdateString("containerProperties.linuxParameters.devices[0].containerPath", value: "string")
json.UpdateString("containerProperties.linuxParameters.devices[0].hostPath", value: "string")
json.UpdateString("containerProperties.linuxParameters.devices[0].permissions[0]", value: "string")
json.UpdateInt("containerProperties.linuxParameters.initProcessEnabled", value: 123)
json.UpdateInt("containerProperties.linuxParameters.maxSwap", value: 123)
json.UpdateInt("containerProperties.linuxParameters.sharedMemorySize", value: 123)
json.UpdateInt("containerProperties.linuxParameters.swappiness", value: 123)
json.UpdateString("containerProperties.linuxParameters.tmpfs[0].containerPath", value: "string")
json.UpdateString("containerProperties.linuxParameters.tmpfs[0].mountOptions[0]", value: "string")
json.UpdateInt("containerProperties.linuxParameters.tmpfs[0].size", value: 123)
json.UpdateString("containerProperties.logConfiguration.logDriver", value: "string")
json.UpdateString("containerProperties.logConfiguration.options.string", value: "string")
json.UpdateString("containerProperties.logConfiguration.secretOptions[0].name", value: "string")
json.UpdateString("containerProperties.logConfiguration.secretOptions[0].valueFrom", value: "string")
json.UpdateInt("containerProperties.memory", value: 123)
json.UpdateString("containerProperties.mountPoints[0].containerPath", value: "string")
json.UpdateInt("containerProperties.mountPoints[0].readOnly", value: 123)
json.UpdateString("containerProperties.mountPoints[0].sourceVolume", value: "string")
json.UpdateString("containerProperties.networkConfiguration.assignPublicIp", value: "string")
json.UpdateInt("containerProperties.privileged", value: 123)
json.UpdateInt("containerProperties.readonlyRootFilesystem", value: 123)
json.UpdateString("containerProperties.resourceRequirements[0].type", value: "string")
json.UpdateString("containerProperties.resourceRequirements[0].value", value: "string")
json.UpdateString("containerProperties.secrets[0].name", value: "string")
json.UpdateString("containerProperties.secrets[0].valueFrom", value: "string")
json.UpdateInt("containerProperties.ulimits[0].hardLimit", value: 123)
json.UpdateString("containerProperties.ulimits[0].name", value: "string")
json.UpdateInt("containerProperties.ulimits[0].softLimit", value: 123)
json.UpdateString("containerProperties.user", value: "string")
json.UpdateInt("containerProperties.vcpus", value: 123)
json.UpdateString("containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId", value: "string")
json.UpdateString("containerProperties.volumes[0].efsVolumeConfiguration.authorizationConfig.iam", value: "string")
json.UpdateString("containerProperties.volumes[0].efsVolumeConfiguration.fileSystemId", value: "string")
json.UpdateString("containerProperties.volumes[0].efsVolumeConfiguration.rootDirectory", value: "string")
json.UpdateString("containerProperties.volumes[0].efsVolumeConfiguration.transitEncryption", value: "string")
json.UpdateInt("containerProperties.volumes[0].efsVolumeConfiguration.transitEncryptionPort", value: 123)
json.UpdateString("containerProperties.volumes[0].host.sourcePath", value: "string")
json.UpdateString("containerProperties.volumes[0].name", value: "string")
json.UpdateString("jobDefinitionName", value: "string")
json.UpdateInt("nodeProperties.mainNode", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.command[0]", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.environment[0].name", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.environment[0].value", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.executionRoleArn", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.fargatePlatformConfiguration.platformVersion", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.image", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.instanceType", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.jobRoleArn", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].containerPath", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].hostPath", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.linuxParameters.devices[0].permissions[0]", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.linuxParameters.initProcessEnabled", value: 123)
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.linuxParameters.maxSwap", value: 123)
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.linuxParameters.sharedMemorySize", value: 123)
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.linuxParameters.swappiness", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].containerPath", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].mountOptions[0]", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.linuxParameters.tmpfs[0].size", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.logConfiguration.logDriver", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.logConfiguration.options.string", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].name", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.logConfiguration.secretOptions[0].valueFrom", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.memory", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.mountPoints[0].containerPath", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.mountPoints[0].readOnly", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.mountPoints[0].sourceVolume", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.networkConfiguration.assignPublicIp", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.privileged", value: 123)
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.readonlyRootFilesystem", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].type", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.resourceRequirements[0].value", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.secrets[0].name", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.secrets[0].valueFrom", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.ulimits[0].hardLimit", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.ulimits[0].name", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.ulimits[0].softLimit", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.user", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.vcpus", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.accessPointId", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.authorizationConfig.iam", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.fileSystemId", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.rootDirectory", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryption", value: "string")
json.UpdateInt("nodeProperties.nodeRangeProperties[0].container.volumes[0].efsVolumeConfiguration.transitEncryptionPort", value: 123)
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].host.sourcePath", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].container.volumes[0].name", value: "string")
json.UpdateString("nodeProperties.nodeRangeProperties[0].targetNodes", value: "string")
json.UpdateInt("nodeProperties.numNodes", value: 123)
json.UpdateString("parameters.string", value: "string")
json.UpdateString("platformCapabilities[0]", value: "string")
json.UpdateInt("propagateTags", value: 123)
json.UpdateInt("retryStrategy.attempts", value: 123)
json.UpdateString("retryStrategy.evaluateOnExit[0].action", value: "string")
json.UpdateString("retryStrategy.evaluateOnExit[0].onExitCode", value: "string")
json.UpdateString("retryStrategy.evaluateOnExit[0].onReason", value: "string")
json.UpdateString("retryStrategy.evaluateOnExit[0].onStatusReason", value: "string")
json.UpdateInt("schedulingPriority", value: 123)
json.UpdateString("tags.string", value: "string")
json.UpdateInt("timeout.attemptDurationSeconds", value: 123)
json.UpdateString("type", value: "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"
// }
rest.AddHeader("Content-Type", value: "application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target", value: "RegisterJobDefinition")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
let sbResponseBody = CkoStringBuilder()
success = rest.FullRequestSb("POST", uriPath: "/v1/registerjobdefinition", requestBody: sbRequestBody, responseBody: sbResponseBody)
if success != true {
print("\(rest.LastErrorText)")
return
}
var respStatusCode: Int = rest.ResponseStatusCode.intValue
print("response status code = \(respStatusCode)")
if respStatusCode != 200 {
print("Response Header:")
print("\(rest.ResponseHeader)")
print("Response Body:")
print("\(sbResponseBody.GetAsString())")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(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
var jobDefinitionArn: String? = jResp.StringOf("jobDefinitionArn")
var jobDefinitionName: String? = jResp.StringOf("jobDefinitionName")
var revision: Int = jResp.IntOf("revision").intValue
// A sample JSON response body parsed by the above code:
// {
// "jobDefinitionArn": "string",
// "jobDefinitionName": "string",
// "revision": number
// }
}
