Chilkat Online Tools

DescribeComputeEnvironments PureBasic Example

AWS Batch

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,"computeEnvironments[0]","string")
    CkJsonObject::ckUpdateInt(json,"maxResults",123)
    CkJsonObject::ckUpdateString(json,"nextToken","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "computeEnvironments": [
    ;     "string"
    ;   ],
    ;   "maxResults": number,
    ;   "nextToken": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeComputeEnvironments")

    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/describecomputeenvironments",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

    computeEnvironmentArn.s
    computeEnvironmentName.s
    AllocationStrategy.s
    BidPercentage.i
    DesiredvCpus.i
    Ec2KeyPair.s
    ImageId.s
    InstanceRole.s
    LaunchTemplateId.s
    LaunchTemplateName.s
    Version.s
    MaxvCpus.i
    MinvCpus.i
    PlacementGroup.s
    SpotIamFleetRole.s
    v_String.s
    v_Type.s
    ecsClusterArn.s
    serviceRole.s
    state.s
    status.s
    statusReason.s
    tagsString.s
    v_type.s
    unmanagedvCpus.i
    JobExecutionTimeoutMinutes.i
    TerminateJobsOnUpdate.i
    j.i
    count_j.i
    imageIdOverride.s
    imageType.s
    strVal.s

    nextToken.s = CkJsonObject::ckStringOf(jResp,"nextToken")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"computeEnvironments")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        computeEnvironmentArn = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeEnvironmentArn")
        computeEnvironmentName = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeEnvironmentName")
        AllocationStrategy = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.allocationStrategy")
        BidPercentage = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].computeResources.bidPercentage")
        DesiredvCpus = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].computeResources.desiredvCpus")
        Ec2KeyPair = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.ec2KeyPair")
        ImageId = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.imageId")
        InstanceRole = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.instanceRole")
        LaunchTemplateId = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.launchTemplate.launchTemplateId")
        LaunchTemplateName = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.launchTemplate.launchTemplateName")
        Version = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.launchTemplate.version")
        MaxvCpus = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].computeResources.maxvCpus")
        MinvCpus = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].computeResources.minvCpus")
        PlacementGroup = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.placementGroup")
        SpotIamFleetRole = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.spotIamFleetRole")
        v_String = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.tags.string")
        v_Type = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.type")
        ecsClusterArn = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].ecsClusterArn")
        serviceRole = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].serviceRole")
        state = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].state")
        status = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].status")
        statusReason = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].statusReason")
        tagsString = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].tags.string")
        v_type = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].type")
        unmanagedvCpus = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].unmanagedvCpus")
        JobExecutionTimeoutMinutes = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].updatePolicy.jobExecutionTimeoutMinutes")
        TerminateJobsOnUpdate = CkJsonObject::ckIntOf(jResp,"computeEnvironments[i].updatePolicy.terminateJobsOnUpdate")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"computeEnvironments[i].computeResources.ec2Configuration")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            imageIdOverride = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.ec2Configuration[j].imageIdOverride")
            imageType = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.ec2Configuration[j].imageType")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"computeEnvironments[i].computeResources.instanceTypes")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.instanceTypes[j]")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"computeEnvironments[i].computeResources.securityGroupIds")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.securityGroupIds[j]")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"computeEnvironments[i].computeResources.subnets")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"computeEnvironments[i].computeResources.subnets[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "computeEnvironments": [
    ;     {
    ;       "computeEnvironmentArn": "string",
    ;       "computeEnvironmentName": "string",
    ;       "computeResources": {
    ;         "allocationStrategy": "string",
    ;         "bidPercentage": number,
    ;         "desiredvCpus": number,
    ;         "ec2Configuration": [
    ;           {
    ;             "imageIdOverride": "string",
    ;             "imageType": "string"
    ;           }
    ;         ],
    ;         "ec2KeyPair": "string",
    ;         "imageId": "string",
    ;         "instanceRole": "string",
    ;         "instanceTypes": [
    ;           "string"
    ;         ],
    ;         "launchTemplate": {
    ;           "launchTemplateId": "string",
    ;           "launchTemplateName": "string",
    ;           "version": "string"
    ;         },
    ;         "maxvCpus": number,
    ;         "minvCpus": number,
    ;         "placementGroup": "string",
    ;         "securityGroupIds": [
    ;           "string"
    ;         ],
    ;         "spotIamFleetRole": "string",
    ;         "subnets": [
    ;           "string"
    ;         ],
    ;         "tags": {
    ;           "string": "string"
    ;         },
    ;         "type": "string"
    ;       },
    ;       "ecsClusterArn": "string",
    ;       "serviceRole": "string",
    ;       "state": "string",
    ;       "status": "string",
    ;       "statusReason": "string",
    ;       "tags": {
    ;         "string": "string"
    ;       },
    ;       "type": "string",
    ;       "unmanagedvCpus": number,
    ;       "updatePolicy": {
    ;         "jobExecutionTimeoutMinutes": number,
    ;         "terminateJobsOnUpdate": boolean
    ;       }
    ;     }
    ;   ],
    ;   "nextToken": "string"
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure