DescribeDataset Ruby Example
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("iotanalytics")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://iotanalytics.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("iotanalytics.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
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeDataset")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/datasets/{datasetName}",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
Arn = jResp.stringOf("dataset.arn")
CreationTime = jResp.IntOf("dataset.creationTime")
LastUpdateTime = jResp.IntOf("dataset.lastUpdateTime")
Name = jResp.stringOf("dataset.name")
NumberOfDays = jResp.IntOf("dataset.retentionPeriod.numberOfDays")
Unlimited = jResp.IntOf("dataset.retentionPeriod.unlimited")
Status = jResp.stringOf("dataset.status")
MaxVersions = jResp.IntOf("dataset.versioningConfiguration.maxVersions")
VersioningConfigurationUnlimited = jResp.IntOf("dataset.versioningConfiguration.unlimited")
i = 0
count_i = jResp.SizeOfArray("dataset.actions")
while i < count_i
jResp.put_I(i)
actionName = jResp.stringOf("dataset.actions[i].actionName")
ExecutionRoleArn = jResp.stringOf("dataset.actions[i].containerAction.executionRoleArn")
Image = jResp.stringOf("dataset.actions[i].containerAction.image")
ComputeType = jResp.stringOf("dataset.actions[i].containerAction.resourceConfiguration.computeType")
VolumeSizeInGB = jResp.IntOf("dataset.actions[i].containerAction.resourceConfiguration.volumeSizeInGB")
SqlQuery = jResp.stringOf("dataset.actions[i].queryAction.sqlQuery")
j = 0
count_j = jResp.SizeOfArray("dataset.actions[i].containerAction.variables")
while j < count_j
jResp.put_J(j)
DatasetName = jResp.stringOf("dataset.actions[i].containerAction.variables[j].datasetContentVersionValue.datasetName")
doubleValue = jResp.IntOf("dataset.actions[i].containerAction.variables[j].doubleValue")
name = jResp.stringOf("dataset.actions[i].containerAction.variables[j].name")
FileName = jResp.stringOf("dataset.actions[i].containerAction.variables[j].outputFileUriValue.fileName")
stringValue = jResp.stringOf("dataset.actions[i].containerAction.variables[j].stringValue")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("dataset.actions[i].queryAction.filters")
while j < count_j
jResp.put_J(j)
OffsetSeconds = jResp.IntOf("dataset.actions[i].queryAction.filters[j].deltaTime.offsetSeconds")
TimeExpression = jResp.stringOf("dataset.actions[i].queryAction.filters[j].deltaTime.timeExpression")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("dataset.contentDeliveryRules")
while i < count_i
jResp.put_I(i)
InputName = jResp.stringOf("dataset.contentDeliveryRules[i].destination.iotEventsDestinationConfiguration.inputName")
RoleArn = jResp.stringOf("dataset.contentDeliveryRules[i].destination.iotEventsDestinationConfiguration.roleArn")
Bucket = jResp.stringOf("dataset.contentDeliveryRules[i].destination.s3DestinationConfiguration.bucket")
DatabaseName = jResp.stringOf("dataset.contentDeliveryRules[i].destination.s3DestinationConfiguration.glueConfiguration.databaseName")
TableName = jResp.stringOf("dataset.contentDeliveryRules[i].destination.s3DestinationConfiguration.glueConfiguration.tableName")
Key = jResp.stringOf("dataset.contentDeliveryRules[i].destination.s3DestinationConfiguration.key")
S3DestinationConfigurationRoleArn = jResp.stringOf("dataset.contentDeliveryRules[i].destination.s3DestinationConfiguration.roleArn")
entryName = jResp.stringOf("dataset.contentDeliveryRules[i].entryName")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("dataset.lateDataRules")
while i < count_i
jResp.put_I(i)
TimeoutInMinutes = jResp.IntOf("dataset.lateDataRules[i].ruleConfiguration.deltaTimeSessionWindowConfiguration.timeoutInMinutes")
ruleName = jResp.stringOf("dataset.lateDataRules[i].ruleName")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("dataset.triggers")
while i < count_i
jResp.put_I(i)
datasetName = jResp.stringOf("dataset.triggers[i].dataset.name")
Expression = jResp.stringOf("dataset.triggers[i].schedule.expression")
i = i + 1
end
# A sample JSON response body parsed by the above code:
# {
# "dataset": {
# "actions": [
# {
# "actionName": "string",
# "containerAction": {
# "executionRoleArn": "string",
# "image": "string",
# "resourceConfiguration": {
# "computeType": "string",
# "volumeSizeInGB": number
# },
# "variables": [
# {
# "datasetContentVersionValue": {
# "datasetName": "string"
# },
# "doubleValue": number,
# "name": "string",
# "outputFileUriValue": {
# "fileName": "string"
# },
# "stringValue": "string"
# }
# ]
# },
# "queryAction": {
# "filters": [
# {
# "deltaTime": {
# "offsetSeconds": number,
# "timeExpression": "string"
# }
# }
# ],
# "sqlQuery": "string"
# }
# }
# ],
# "arn": "string",
# "contentDeliveryRules": [
# {
# "destination": {
# "iotEventsDestinationConfiguration": {
# "inputName": "string",
# "roleArn": "string"
# },
# "s3DestinationConfiguration": {
# "bucket": "string",
# "glueConfiguration": {
# "databaseName": "string",
# "tableName": "string"
# },
# "key": "string",
# "roleArn": "string"
# }
# },
# "entryName": "string"
# }
# ],
# "creationTime": number,
# "lastUpdateTime": number,
# "lateDataRules": [
# {
# "ruleConfiguration": {
# "deltaTimeSessionWindowConfiguration": {
# "timeoutInMinutes": number
# }
# },
# "ruleName": "string"
# }
# ],
# "name": "string",
# "retentionPeriod": {
# "numberOfDays": number,
# "unlimited": boolean
# },
# "status": "string",
# "triggers": [
# {
# "dataset": {
# "name": "string"
# },
# "schedule": {
# "expression": "string"
# }
# }
# ],
# "versioningConfiguration": {
# "maxVersions": number,
# "unlimited": boolean
# }
# }
# }
