Chilkat Online Tools

DescribeChannel Perl Example

AWS IoT Analytics

use 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,1,1);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$rest->AddHeader("Content-Type","application/x-amz-json-1.1");
$rest->AddHeader("X-Amz-Target","DescribeChannel");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestNoBodySb("GET","/channels/{channelName}",$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print "response status code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 200) {
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$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("channel.arn");
$CreationTime = $jResp->IntOf("channel.creationTime");
$LastMessageArrivalTime = $jResp->IntOf("channel.lastMessageArrivalTime");
$LastUpdateTime = $jResp->IntOf("channel.lastUpdateTime");
$Name = $jResp->stringOf("channel.name");
$NumberOfDays = $jResp->IntOf("channel.retentionPeriod.numberOfDays");
$Unlimited = $jResp->IntOf("channel.retentionPeriod.unlimited");
$Status = $jResp->stringOf("channel.status");
$Bucket = $jResp->stringOf("channel.storage.customerManagedS3.bucket");
$KeyPrefix = $jResp->stringOf("channel.storage.customerManagedS3.keyPrefix");
$RoleArn = $jResp->stringOf("channel.storage.customerManagedS3.roleArn");
$EstimatedOn = $jResp->IntOf("statistics.size.estimatedOn");
$EstimatedSizeInBytes = $jResp->IntOf("statistics.size.estimatedSizeInBytes");

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

# {
#   "channel": {
#     "arn": "string",
#     "creationTime": number,
#     "lastMessageArrivalTime": number,
#     "lastUpdateTime": number,
#     "name": "string",
#     "retentionPeriod": {
#       "numberOfDays": number,
#       "unlimited": boolean
#     },
#     "status": "string",
#     "storage": {
#       "customerManagedS3": {
#         "bucket": "string",
#         "keyPrefix": "string",
#         "roleArn": "string"
#       },
#       "serviceManagedS3": {}
#     }
#   },
#   "statistics": {
#     "size": {
#       "estimatedOn": number,
#       "estimatedSizeInBytes": number
#     }
#   }
# }