Chilkat Online Tools

GetMetricData Ruby Example

Amazon Connect

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("connect")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://connect.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("connect.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.UpdateInt("EndTime",123)
json.UpdateString("Filters.Channels[0]","string")
json.UpdateString("Filters.Queues[0]","string")
json.UpdateString("Groupings[0]","string")
json.UpdateString("HistoricalMetrics[0].Name","string")
json.UpdateString("HistoricalMetrics[0].Statistic","string")
json.UpdateString("HistoricalMetrics[0].Threshold.Comparison","string")
json.UpdateInt("HistoricalMetrics[0].Threshold.ThresholdValue",123)
json.UpdateString("HistoricalMetrics[0].Unit","string")
json.UpdateInt("MaxResults",123)
json.UpdateString("NextToken","string")
json.UpdateInt("StartTime",123)

# The JSON request body created by the above code:

# {
#   "EndTime": number,
#   "Filters": {
#     "Channels": [
#       "string"
#     ],
#     "Queues": [
#       "string"
#     ]
#   },
#   "Groupings": [
#     "string"
#   ],
#   "HistoricalMetrics": [
#     {
#       "Name": "string",
#       "Statistic": "string",
#       "Threshold": {
#         "Comparison": "string",
#         "ThresholdValue": number
#       },
#       "Unit": "string"
#     }
#   ],
#   "MaxResults": number,
#   "NextToken": "string",
#   "StartTime": number
# }

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/metrics/historical/{InstanceId}",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("MetricResults")
while i < count_i
    jResp.put_I(i)
    Channel = jResp.stringOf("MetricResults[i].Dimensions.Channel")
    Arn = jResp.stringOf("MetricResults[i].Dimensions.Queue.Arn")
    Id = jResp.stringOf("MetricResults[i].Dimensions.Queue.Id")
    j = 0
    count_j = jResp.SizeOfArray("MetricResults[i].Collections")
    while j < count_j
        jResp.put_J(j)
        Name = jResp.stringOf("MetricResults[i].Collections[j].Metric.Name")
        Statistic = jResp.stringOf("MetricResults[i].Collections[j].Metric.Statistic")
        Comparison = jResp.stringOf("MetricResults[i].Collections[j].Metric.Threshold.Comparison")
        ThresholdValue = jResp.IntOf("MetricResults[i].Collections[j].Metric.Threshold.ThresholdValue")
        Unit = jResp.stringOf("MetricResults[i].Collections[j].Metric.Unit")
        Value = jResp.IntOf("MetricResults[i].Collections[j].Value")
        j = j + 1
    end
    i = i + 1
end

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

# {
#   "MetricResults": [
#     {
#       "Collections": [
#         {
#           "Metric": {
#             "Name": "string",
#             "Statistic": "string",
#             "Threshold": {
#               "Comparison": "string",
#               "ThresholdValue": number
#             },
#             "Unit": "string"
#           },
#           "Value": number
#         }
#       ],
#       "Dimensions": {
#         "Channel": "string",
#         "Queue": {
#           "Arn": "string",
#           "Id": "string"
#         }
#       }
#     }
#   ],
#   "NextToken": "string"
# }