Chilkat Online Tools

ListReceivedLicenses PureBasic Example

AWS License Manager

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, "license-manager")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://license-manager.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"license-manager.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,"Filters[0].Name","string")
    CkJsonObject::ckUpdateString(json,"Filters[0].Values[0]","string")
    CkJsonObject::ckUpdateString(json,"LicenseArns[0]","string")
    CkJsonObject::ckUpdateInt(json,"MaxResults",123)
    CkJsonObject::ckUpdateString(json,"NextToken","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "Filters": [
    ;     {
    ;       "Name": "string",
    ;       "Values": [
    ;         "string"
    ;       ]
    ;     }
    ;   ],
    ;   "LicenseArns": [
    ;     "string"
    ;   ],
    ;   "MaxResults": number,
    ;   "NextToken": "string"
    ; }

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

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

    Beneficiary.s
    AllowEarlyCheckIn.i
    MaxTimeToLiveInMinutes.i
    ProvisionalConfigurationMaxTimeToLiveInMinutes.i
    RenewType.s
    CreateTime.s
    HomeRegion.s
    KeyFingerprint.s
    Name.s
    SignKey.s
    LicenseArn.s
    LicenseName.s
    ProductName.s
    ProductSKU.s
    ReceivedStatus.s
    ReceivedStatusReason.s
    Status.s
    Begin.s
    v_End.s
    Version.s
    j.i
    count_j.i
    AllowCheckIn.i
    MaxCount.i
    Overage.i
    Unit.s
    Value.s
    strVal.s

    NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Licenses")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Beneficiary = CkJsonObject::ckStringOf(jResp,"Licenses[i].Beneficiary")
        AllowEarlyCheckIn = CkJsonObject::ckIntOf(jResp,"Licenses[i].ConsumptionConfiguration.BorrowConfiguration.AllowEarlyCheckIn")
        MaxTimeToLiveInMinutes = CkJsonObject::ckIntOf(jResp,"Licenses[i].ConsumptionConfiguration.BorrowConfiguration.MaxTimeToLiveInMinutes")
        ProvisionalConfigurationMaxTimeToLiveInMinutes = CkJsonObject::ckIntOf(jResp,"Licenses[i].ConsumptionConfiguration.ProvisionalConfiguration.MaxTimeToLiveInMinutes")
        RenewType = CkJsonObject::ckStringOf(jResp,"Licenses[i].ConsumptionConfiguration.RenewType")
        CreateTime = CkJsonObject::ckStringOf(jResp,"Licenses[i].CreateTime")
        HomeRegion = CkJsonObject::ckStringOf(jResp,"Licenses[i].HomeRegion")
        KeyFingerprint = CkJsonObject::ckStringOf(jResp,"Licenses[i].Issuer.KeyFingerprint")
        Name = CkJsonObject::ckStringOf(jResp,"Licenses[i].Issuer.Name")
        SignKey = CkJsonObject::ckStringOf(jResp,"Licenses[i].Issuer.SignKey")
        LicenseArn = CkJsonObject::ckStringOf(jResp,"Licenses[i].LicenseArn")
        LicenseName = CkJsonObject::ckStringOf(jResp,"Licenses[i].LicenseName")
        ProductName = CkJsonObject::ckStringOf(jResp,"Licenses[i].ProductName")
        ProductSKU = CkJsonObject::ckStringOf(jResp,"Licenses[i].ProductSKU")
        ReceivedStatus = CkJsonObject::ckStringOf(jResp,"Licenses[i].ReceivedMetadata.ReceivedStatus")
        ReceivedStatusReason = CkJsonObject::ckStringOf(jResp,"Licenses[i].ReceivedMetadata.ReceivedStatusReason")
        Status = CkJsonObject::ckStringOf(jResp,"Licenses[i].Status")
        Begin = CkJsonObject::ckStringOf(jResp,"Licenses[i].Validity.Begin")
        v_End = CkJsonObject::ckStringOf(jResp,"Licenses[i].Validity.End")
        Version = CkJsonObject::ckStringOf(jResp,"Licenses[i].Version")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"Licenses[i].Entitlements")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            AllowCheckIn = CkJsonObject::ckIntOf(jResp,"Licenses[i].Entitlements[j].AllowCheckIn")
            MaxCount = CkJsonObject::ckIntOf(jResp,"Licenses[i].Entitlements[j].MaxCount")
            Name = CkJsonObject::ckStringOf(jResp,"Licenses[i].Entitlements[j].Name")
            Overage = CkJsonObject::ckIntOf(jResp,"Licenses[i].Entitlements[j].Overage")
            Unit = CkJsonObject::ckStringOf(jResp,"Licenses[i].Entitlements[j].Unit")
            Value = CkJsonObject::ckStringOf(jResp,"Licenses[i].Entitlements[j].Value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"Licenses[i].LicenseMetadata")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            Name = CkJsonObject::ckStringOf(jResp,"Licenses[i].LicenseMetadata[j].Name")
            Value = CkJsonObject::ckStringOf(jResp,"Licenses[i].LicenseMetadata[j].Value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"Licenses[i].ReceivedMetadata.AllowedOperations")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"Licenses[i].ReceivedMetadata.AllowedOperations[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend

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

    ; {
    ;   "Licenses": [
    ;     {
    ;       "Beneficiary": "string",
    ;       "ConsumptionConfiguration": {
    ;         "BorrowConfiguration": {
    ;           "AllowEarlyCheckIn": boolean,
    ;           "MaxTimeToLiveInMinutes": number
    ;         },
    ;         "ProvisionalConfiguration": {
    ;           "MaxTimeToLiveInMinutes": number
    ;         },
    ;         "RenewType": "string"
    ;       },
    ;       "CreateTime": "string",
    ;       "Entitlements": [
    ;         {
    ;           "AllowCheckIn": boolean,
    ;           "MaxCount": number,
    ;           "Name": "string",
    ;           "Overage": boolean,
    ;           "Unit": "string",
    ;           "Value": "string"
    ;         }
    ;       ],
    ;       "HomeRegion": "string",
    ;       "Issuer": {
    ;         "KeyFingerprint": "string",
    ;         "Name": "string",
    ;         "SignKey": "string"
    ;       },
    ;       "LicenseArn": "string",
    ;       "LicenseMetadata": [
    ;         {
    ;           "Name": "string",
    ;           "Value": "string"
    ;         }
    ;       ],
    ;       "LicenseName": "string",
    ;       "ProductName": "string",
    ;       "ProductSKU": "string",
    ;       "ReceivedMetadata": {
    ;         "AllowedOperations": [
    ;           "string"
    ;         ],
    ;         "ReceivedStatus": "string",
    ;         "ReceivedStatusReason": "string"
    ;       },
    ;       "Status": "string",
    ;       "Validity": {
    ;         "Begin": "string",
    ;         "End": "string"
    ;       },
    ;       "Version": "string"
    ;     }
    ;   ],
    ;   "NextToken": "string"
    ; }


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


    ProcedureReturn
EndProcedure