Chilkat Online Tools

DescribeDataset Xojo Example

AWS IoT Analytics

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

Dim rest As New Chilkat.Rest
Dim success As Boolean

Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.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.Region = "us-west-2"
authAws.ServiceName = "iotanalytics"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
success = 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) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/datasets/{datasetName}",sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(sbResponseBody.GetAsString())
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = 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

Dim actionName As String
Dim ExecutionRoleArn As String
Dim Image As String
Dim ComputeType As String
Dim VolumeSizeInGB As Int32
Dim SqlQuery As String
Dim j As Int32
Dim count_j As Int32
Dim DatasetName As String
Dim doubleValue As Int32
Dim name As String
Dim FileName As String
Dim stringValue As String
Dim OffsetSeconds As Int32
Dim TimeExpression As String
Dim InputName As String
Dim RoleArn As String
Dim Bucket As String
Dim DatabaseName As String
Dim TableName As String
Dim Key As String
Dim S3DestinationConfigurationRoleArn As String
Dim entryName As String
Dim TimeoutInMinutes As Int32
Dim ruleName As String
Dim datasetName As String
Dim Expression As String

Dim Arn As String
Arn = jResp.StringOf("dataset.arn")
Dim CreationTime As Int32
CreationTime = jResp.IntOf("dataset.creationTime")
Dim LastUpdateTime As Int32
LastUpdateTime = jResp.IntOf("dataset.lastUpdateTime")
Dim Name As String
Name = jResp.StringOf("dataset.name")
Dim NumberOfDays As Int32
NumberOfDays = jResp.IntOf("dataset.retentionPeriod.numberOfDays")
Dim Unlimited As Int32
Unlimited = jResp.IntOf("dataset.retentionPeriod.unlimited")
Dim Status As String
Status = jResp.StringOf("dataset.status")
Dim MaxVersions As Int32
MaxVersions = jResp.IntOf("dataset.versioningConfiguration.maxVersions")
Dim VersioningConfigurationUnlimited As Int32
VersioningConfigurationUnlimited = jResp.IntOf("dataset.versioningConfiguration.unlimited")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("dataset.actions")
While i < count_i
    jResp.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.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
    Wend
    j = 0
    count_j = jResp.SizeOfArray("dataset.actions[i].queryAction.filters")
    While j < count_j
        jResp.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
    Wend
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("dataset.contentDeliveryRules")
While i < count_i
    jResp.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
Wend
i = 0
count_i = jResp.SizeOfArray("dataset.lateDataRules")
While i < count_i
    jResp.I = i
    TimeoutInMinutes = jResp.IntOf("dataset.lateDataRules[i].ruleConfiguration.deltaTimeSessionWindowConfiguration.timeoutInMinutes")
    ruleName = jResp.StringOf("dataset.lateDataRules[i].ruleName")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("dataset.triggers")
While i < count_i
    jResp.I = i
    datasetName = jResp.StringOf("dataset.triggers[i].dataset.name")
    Expression = jResp.StringOf("dataset.triggers[i].schedule.expression")
    i = i + 1
Wend

// 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
//     }
//   }
// }