Chilkat Online Tools

DescribeDatastore Ruby Example

AWS IoT Analytics

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","DescribeDatastore")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/datastores/{datastoreName}",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("datastore.arn")
CreationTime = jResp.IntOf("datastore.creationTime")
LastMessageArrivalTime = jResp.IntOf("datastore.lastMessageArrivalTime")
LastUpdateTime = jResp.IntOf("datastore.lastUpdateTime")
Name = jResp.stringOf("datastore.name")
NumberOfDays = jResp.IntOf("datastore.retentionPeriod.numberOfDays")
Unlimited = jResp.IntOf("datastore.retentionPeriod.unlimited")
Status = jResp.stringOf("datastore.status")
Bucket = jResp.stringOf("datastore.storage.customerManagedS3.bucket")
KeyPrefix = jResp.stringOf("datastore.storage.customerManagedS3.keyPrefix")
RoleArn = jResp.stringOf("datastore.storage.customerManagedS3.roleArn")
CustomerManagedS3StorageBucket = jResp.stringOf("datastore.storage.iotSiteWiseMultiLayerStorage.customerManagedS3Storage.bucket")
CustomerManagedS3StorageKeyPrefix = jResp.stringOf("datastore.storage.iotSiteWiseMultiLayerStorage.customerManagedS3Storage.keyPrefix")
EstimatedOn = jResp.IntOf("statistics.size.estimatedOn")
EstimatedSizeInBytes = jResp.IntOf("statistics.size.estimatedSizeInBytes")
i = 0
count_i = jResp.SizeOfArray("datastore.datastorePartitions.partitions")
while i < count_i
    jResp.put_I(i)
    AttributeName = jResp.stringOf("datastore.datastorePartitions.partitions[i].attributePartition.attributeName")
    timestampPartitionAttributeName = jResp.stringOf("datastore.datastorePartitions.partitions[i].timestampPartition.attributeName")
    TimestampFormat = jResp.stringOf("datastore.datastorePartitions.partitions[i].timestampPartition.timestampFormat")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns[i].name")
    v_type = jResp.stringOf("datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns[i].type")
    i = i + 1
end

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

# {
#   "datastore": {
#     "arn": "string",
#     "creationTime": number,
#     "datastorePartitions": {
#       "partitions": [
#         {
#           "attributePartition": {
#             "attributeName": "string"
#           },
#           "timestampPartition": {
#             "attributeName": "string",
#             "timestampFormat": "string"
#           }
#         }
#       ]
#     },
#     "fileFormatConfiguration": {
#       "jsonConfiguration": {},
#       "parquetConfiguration": {
#         "schemaDefinition": {
#           "columns": [
#             {
#               "name": "string",
#               "type": "string"
#             }
#           ]
#         }
#       }
#     },
#     "lastMessageArrivalTime": number,
#     "lastUpdateTime": number,
#     "name": "string",
#     "retentionPeriod": {
#       "numberOfDays": number,
#       "unlimited": boolean
#     },
#     "status": "string",
#     "storage": {
#       "customerManagedS3": {
#         "bucket": "string",
#         "keyPrefix": "string",
#         "roleArn": "string"
#       },
#       "iotSiteWiseMultiLayerStorage": {
#         "customerManagedS3Storage": {
#           "bucket": "string",
#           "keyPrefix": "string"
#         }
#       },
#       "serviceManagedS3": {}
#     }
#   },
#   "statistics": {
#     "size": {
#       "estimatedOn": number,
#       "estimatedSizeInBytes": number
#     }
#   }
# }