Chilkat Online Tools

DescribeOrganization Ruby Example

Amazon WorkMail

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

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

# The JSON request body created by the above code:

# {
#   "OrganizationId": "string"
# }

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

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

Alias = jResp.stringOf("Alias")
ARN = jResp.stringOf("ARN")
CompletedDate = jResp.IntOf("CompletedDate")
DefaultMailDomain = jResp.stringOf("DefaultMailDomain")
DirectoryId = jResp.stringOf("DirectoryId")
DirectoryType = jResp.stringOf("DirectoryType")
ErrorMessage = jResp.stringOf("ErrorMessage")
OrganizationId = jResp.stringOf("OrganizationId")
State = jResp.stringOf("State")

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

# {
#   "Alias": "string",
#   "ARN": "string",
#   "CompletedDate": number,
#   "DefaultMailDomain": "string",
#   "DirectoryId": "string",
#   "DirectoryType": "string",
#   "ErrorMessage": "string",
#   "OrganizationId": "string",
#   "State": "string"
# }