Chilkat Online Tools

DescribeSMBFileShares Ruby Example

AWS Storage Gateway

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("storagegateway")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://storagegateway.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("storagegateway.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

# 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

json = Chilkat::CkJsonObject.new()
json.UpdateString("FileShareARNList[0]","string")

# The JSON request body created by the above code:

# {
#   "FileShareARNList": [
#     "string"
#   ]
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","StorageGateway_20130630.DescribeSMBFileShares")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,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

i = 0
count_i = jResp.SizeOfArray("SMBFileShareInfoList")
while i < count_i
    jResp.put_I(i)
    AccessBasedEnumeration = jResp.IntOf("SMBFileShareInfoList[i].AccessBasedEnumeration")
    AuditDestinationARN = jResp.stringOf("SMBFileShareInfoList[i].AuditDestinationARN")
    Authentication = jResp.stringOf("SMBFileShareInfoList[i].Authentication")
    BucketRegion = jResp.stringOf("SMBFileShareInfoList[i].BucketRegion")
    CacheStaleTimeoutInSeconds = jResp.IntOf("SMBFileShareInfoList[i].CacheAttributes.CacheStaleTimeoutInSeconds")
    CaseSensitivity = jResp.stringOf("SMBFileShareInfoList[i].CaseSensitivity")
    DefaultStorageClass = jResp.stringOf("SMBFileShareInfoList[i].DefaultStorageClass")
    FileShareARN = jResp.stringOf("SMBFileShareInfoList[i].FileShareARN")
    FileShareId = jResp.stringOf("SMBFileShareInfoList[i].FileShareId")
    FileShareName = jResp.stringOf("SMBFileShareInfoList[i].FileShareName")
    FileShareStatus = jResp.stringOf("SMBFileShareInfoList[i].FileShareStatus")
    GatewayARN = jResp.stringOf("SMBFileShareInfoList[i].GatewayARN")
    GuessMIMETypeEnabled = jResp.IntOf("SMBFileShareInfoList[i].GuessMIMETypeEnabled")
    KMSEncrypted = jResp.IntOf("SMBFileShareInfoList[i].KMSEncrypted")
    KMSKey = jResp.stringOf("SMBFileShareInfoList[i].KMSKey")
    LocationARN = jResp.stringOf("SMBFileShareInfoList[i].LocationARN")
    NotificationPolicy = jResp.stringOf("SMBFileShareInfoList[i].NotificationPolicy")
    ObjectACL = jResp.stringOf("SMBFileShareInfoList[i].ObjectACL")
    OplocksEnabled = jResp.IntOf("SMBFileShareInfoList[i].OplocksEnabled")
    Path = jResp.stringOf("SMBFileShareInfoList[i].Path")
    ReadOnly = jResp.IntOf("SMBFileShareInfoList[i].ReadOnly")
    RequesterPays = jResp.IntOf("SMBFileShareInfoList[i].RequesterPays")
    Role = jResp.stringOf("SMBFileShareInfoList[i].Role")
    SMBACLEnabled = jResp.IntOf("SMBFileShareInfoList[i].SMBACLEnabled")
    VPCEndpointDNSName = jResp.stringOf("SMBFileShareInfoList[i].VPCEndpointDNSName")
    j = 0
    count_j = jResp.SizeOfArray("SMBFileShareInfoList[i].AdminUserList")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("SMBFileShareInfoList[i].AdminUserList[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("SMBFileShareInfoList[i].InvalidUserList")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("SMBFileShareInfoList[i].InvalidUserList[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("SMBFileShareInfoList[i].Tags")
    while j < count_j
        jResp.put_J(j)
        Key = jResp.stringOf("SMBFileShareInfoList[i].Tags[j].Key")
        Value = jResp.stringOf("SMBFileShareInfoList[i].Tags[j].Value")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("SMBFileShareInfoList[i].ValidUserList")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("SMBFileShareInfoList[i].ValidUserList[j]")
        j = j + 1
    end
    i = i + 1
end

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

# {
#   "SMBFileShareInfoList": [
#     {
#       "AccessBasedEnumeration": boolean,
#       "AdminUserList": [
#         "string"
#       ],
#       "AuditDestinationARN": "string",
#       "Authentication": "string",
#       "BucketRegion": "string",
#       "CacheAttributes": {
#         "CacheStaleTimeoutInSeconds": number
#       },
#       "CaseSensitivity": "string",
#       "DefaultStorageClass": "string",
#       "FileShareARN": "string",
#       "FileShareId": "string",
#       "FileShareName": "string",
#       "FileShareStatus": "string",
#       "GatewayARN": "string",
#       "GuessMIMETypeEnabled": boolean,
#       "InvalidUserList": [
#         "string"
#       ],
#       "KMSEncrypted": boolean,
#       "KMSKey": "string",
#       "LocationARN": "string",
#       "NotificationPolicy": "string",
#       "ObjectACL": "string",
#       "OplocksEnabled": boolean,
#       "Path": "string",
#       "ReadOnly": boolean,
#       "RequesterPays": boolean,
#       "Role": "string",
#       "SMBACLEnabled": boolean,
#       "Tags": [
#         {
#           "Key": "string",
#           "Value": "string"
#         }
#       ],
#       "ValidUserList": [
#         "string"
#       ],
#       "VPCEndpointDNSName": "string"
#     }
#   ]
# }