Chilkat Online Tools

ListReceivedLicenses Ruby Example

AWS License Manager

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_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.put_Region("us-west-2")
authAws.put_ServiceName("license-manager")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://license-manager.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("license-manager.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("Filters[0].Name","string")
json.UpdateString("Filters[0].Values[0]","string")
json.UpdateString("LicenseArns[0]","string")
json.UpdateInt("MaxResults",123)
json.UpdateString("NextToken","string")

# The JSON request body created by the above code:

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

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
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

NextToken = jResp.stringOf("NextToken")
i = 0
count_i = jResp.SizeOfArray("Licenses")
while i < count_i
    jResp.put_I(i)
    Beneficiary = jResp.stringOf("Licenses[i].Beneficiary")
    AllowEarlyCheckIn = jResp.IntOf("Licenses[i].ConsumptionConfiguration.BorrowConfiguration.AllowEarlyCheckIn")
    MaxTimeToLiveInMinutes = jResp.IntOf("Licenses[i].ConsumptionConfiguration.BorrowConfiguration.MaxTimeToLiveInMinutes")
    ProvisionalConfigurationMaxTimeToLiveInMinutes = jResp.IntOf("Licenses[i].ConsumptionConfiguration.ProvisionalConfiguration.MaxTimeToLiveInMinutes")
    RenewType = jResp.stringOf("Licenses[i].ConsumptionConfiguration.RenewType")
    CreateTime = jResp.stringOf("Licenses[i].CreateTime")
    HomeRegion = jResp.stringOf("Licenses[i].HomeRegion")
    KeyFingerprint = jResp.stringOf("Licenses[i].Issuer.KeyFingerprint")
    Name = jResp.stringOf("Licenses[i].Issuer.Name")
    SignKey = jResp.stringOf("Licenses[i].Issuer.SignKey")
    LicenseArn = jResp.stringOf("Licenses[i].LicenseArn")
    LicenseName = jResp.stringOf("Licenses[i].LicenseName")
    ProductName = jResp.stringOf("Licenses[i].ProductName")
    ProductSKU = jResp.stringOf("Licenses[i].ProductSKU")
    ReceivedStatus = jResp.stringOf("Licenses[i].ReceivedMetadata.ReceivedStatus")
    ReceivedStatusReason = jResp.stringOf("Licenses[i].ReceivedMetadata.ReceivedStatusReason")
    Status = jResp.stringOf("Licenses[i].Status")
    Begin = jResp.stringOf("Licenses[i].Validity.Begin")
    v_End = jResp.stringOf("Licenses[i].Validity.End")
    Version = jResp.stringOf("Licenses[i].Version")
    j = 0
    count_j = jResp.SizeOfArray("Licenses[i].Entitlements")
    while j < count_j
        jResp.put_J(j)
        AllowCheckIn = jResp.IntOf("Licenses[i].Entitlements[j].AllowCheckIn")
        MaxCount = jResp.IntOf("Licenses[i].Entitlements[j].MaxCount")
        Name = jResp.stringOf("Licenses[i].Entitlements[j].Name")
        Overage = jResp.IntOf("Licenses[i].Entitlements[j].Overage")
        Unit = jResp.stringOf("Licenses[i].Entitlements[j].Unit")
        Value = jResp.stringOf("Licenses[i].Entitlements[j].Value")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("Licenses[i].LicenseMetadata")
    while j < count_j
        jResp.put_J(j)
        Name = jResp.stringOf("Licenses[i].LicenseMetadata[j].Name")
        Value = jResp.stringOf("Licenses[i].LicenseMetadata[j].Value")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("Licenses[i].ReceivedMetadata.AllowedOperations")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("Licenses[i].ReceivedMetadata.AllowedOperations[j]")
        j = j + 1
    end
    i = i + 1
end

# 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"
# }