Chilkat Online Tools

DescribeChannel phpAx Example

AWS IoT Analytics

<?php

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

$rest = new COM("Chilkat_9_5_0.Rest");

$authAws = new COM("Chilkat_9_5_0.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
$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->ConnectFailReason . "\n";
    print $rest->LastErrorText . "\n";
    exit;
}

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

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $rest->FullRequestNoBodySb('GET','/channels/{channelName}',$sbResponseBody);
if ($success != 1) {
    print $rest->LastErrorText . "\n";
    exit;
}

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

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$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
//     }
//   }
// }

?>