DescribeStream Swift3 Example
func chilkatTest() {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let rest = CkoRest()!
var success: Bool
let authAws = CkoAuthAws()!
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 = "kinesisvideo"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.setAuthAws(authAws)
// URL: https://kinesisvideo.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = rest.connect("kinesisvideo.us-west-2.amazonaws.com", port: 443, tls: true, autoReconnect: true)
if success != true {
print("ConnectFailReason: \(rest.connectFailReason.intValue)")
print("\(rest.lastErrorText!)")
return
}
// The following code creates the JSON request body.
// The JSON created by this code is shown below.
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
let json = CkoJsonObject()!
json.update("ExclusiveStartShardId", value: "string")
json.updateInt("Limit", value: 123)
json.update("StreamName", value: "string")
// The JSON request body created by the above code:
// {
// "ExclusiveStartShardId": "string",
// "Limit": number,
// "StreamName": "string"
// }
rest.addHeader("Content-Type", value: "application/x-amz-json-1.1")
rest.addHeader("X-Amz-Target", value: "DescribeStream")
let sbRequestBody = CkoStringBuilder()!
json.emitSb(sbRequestBody)
let sbResponseBody = CkoStringBuilder()!
success = rest.fullRequestSb("POST", uriPath: "/describeStream", requestBody: sbRequestBody, responseBody: sbResponseBody)
if success != true {
print("\(rest.lastErrorText!)")
return
}
var respStatusCode: Int = rest.responseStatusCode.intValue
print("response status code = \(respStatusCode)")
if respStatusCode != 200 {
print("Response Header:")
print("\(rest.responseHeader!)")
print("Response Body:")
print("\(sbResponseBody.getAsString()!)")
return
}
let jResp = CkoJsonObject()!
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
var j: Int
var count_j: Int
var strVal: String?
var AdjacentParentShardId: String?
var EndingHashKey: String?
var StartingHashKey: String?
var ParentShardId: String?
var EndingSequenceNumber: String?
var StartingSequenceNumber: String?
var ShardId: String?
var EncryptionType: String? = jResp.string(of: "StreamDescription.EncryptionType")
var HasMoreShards: Int = jResp.int(of: "StreamDescription.HasMoreShards").intValue
var KeyId: String? = jResp.string(of: "StreamDescription.KeyId")
var RetentionPeriodHours: Int = jResp.int(of: "StreamDescription.RetentionPeriodHours").intValue
var StreamARN: String? = jResp.string(of: "StreamDescription.StreamARN")
var StreamCreationTimestamp: Int = jResp.int(of: "StreamDescription.StreamCreationTimestamp").intValue
var StreamMode: String? = jResp.string(of: "StreamDescription.StreamModeDetails.StreamMode")
var StreamName: String? = jResp.string(of: "StreamDescription.StreamName")
var StreamStatus: String? = jResp.string(of: "StreamDescription.StreamStatus")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "StreamDescription.EnhancedMonitoring").intValue
while i < count_i {
jResp.i = i
j = 0
count_j = jResp.size(ofArray: "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics").intValue
while j < count_j {
jResp.j = j
strVal = jResp.string(of: "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]")
j = j + 1
}
i = i + 1
}
i = 0
count_i = jResp.size(ofArray: "StreamDescription.Shards").intValue
while i < count_i {
jResp.i = i
AdjacentParentShardId = jResp.string(of: "StreamDescription.Shards[i].AdjacentParentShardId")
EndingHashKey = jResp.string(of: "StreamDescription.Shards[i].HashKeyRange.EndingHashKey")
StartingHashKey = jResp.string(of: "StreamDescription.Shards[i].HashKeyRange.StartingHashKey")
ParentShardId = jResp.string(of: "StreamDescription.Shards[i].ParentShardId")
EndingSequenceNumber = jResp.string(of: "StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber")
StartingSequenceNumber = jResp.string(of: "StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber")
ShardId = jResp.string(of: "StreamDescription.Shards[i].ShardId")
i = i + 1
}
// A sample JSON response body parsed by the above code:
// {
// "StreamDescription": {
// "EncryptionType": "string",
// "EnhancedMonitoring": [
// {
// "ShardLevelMetrics": [
// "string"
// ]
// }
// ],
// "HasMoreShards": boolean,
// "KeyId": "string",
// "RetentionPeriodHours": number,
// "Shards": [
// {
// "AdjacentParentShardId": "string",
// "HashKeyRange": {
// "EndingHashKey": "string",
// "StartingHashKey": "string"
// },
// "ParentShardId": "string",
// "SequenceNumberRange": {
// "EndingSequenceNumber": "string",
// "StartingSequenceNumber": "string"
// },
// "ShardId": "string"
// }
// ],
// "StreamARN": "string",
// "StreamCreationTimestamp": number,
// "StreamModeDetails": {
// "StreamMode": "string"
// },
// "StreamName": "string",
// "StreamStatus": "string"
// }
// }
}
