Chilkat Online Tools

ListPiiEntitiesDetectionJobs Ruby Example

Amazon Comprehend

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

# URL: https://comprehend.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("comprehend.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("Filter.JobName","string")
json.UpdateString("Filter.JobStatus","string")
json.UpdateInt("Filter.SubmitTimeAfter",123)
json.UpdateInt("Filter.SubmitTimeBefore",123)
json.UpdateInt("MaxResults",123)
json.UpdateString("NextToken","string")

# The JSON request body created by the above code:

# {
#   "Filter": {
#     "JobName": "string",
#     "JobStatus": "string",
#     "SubmitTimeAfter": number,
#     "SubmitTimeBefore": number
#   },
#   "MaxResults": number,
#   "NextToken": "string"
# }

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

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

NextToken = jResp.stringOf("NextToken")
i = 0
count_i = jResp.SizeOfArray("PiiEntitiesDetectionJobPropertiesList")
while i < count_i
    jResp.put_I(i)
    DataAccessRoleArn = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].DataAccessRoleArn")
    EndTime = jResp.IntOf("PiiEntitiesDetectionJobPropertiesList[i].EndTime")
    DocumentReadAction = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadAction")
    DocumentReadMode = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadMode")
    InputFormat = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.InputFormat")
    S3Uri = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.S3Uri")
    JobArn = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].JobArn")
    JobId = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].JobId")
    JobName = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].JobName")
    JobStatus = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].JobStatus")
    LanguageCode = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].LanguageCode")
    Message = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].Message")
    Mode = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].Mode")
    KmsKeyId = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].OutputDataConfig.KmsKeyId")
    OutputDataConfigS3Uri = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].OutputDataConfig.S3Uri")
    MaskCharacter = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.MaskCharacter")
    MaskMode = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.MaskMode")
    SubmitTime = jResp.IntOf("PiiEntitiesDetectionJobPropertiesList[i].SubmitTime")
    j = 0
    count_j = jResp.SizeOfArray("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.PiiEntityTypes")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.PiiEntityTypes[j]")
        j = j + 1
    end
    i = i + 1
end

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

# {
#   "NextToken": "string",
#   "PiiEntitiesDetectionJobPropertiesList": [
#     {
#       "DataAccessRoleArn": "string",
#       "EndTime": number,
#       "InputDataConfig": {
#         "DocumentReaderConfig": {
#           "DocumentReadAction": "string",
#           "DocumentReadMode": "string",
#           "FeatureTypes": [
#             "string"
#           ]
#         },
#         "InputFormat": "string",
#         "S3Uri": "string"
#       },
#       "JobArn": "string",
#       "JobId": "string",
#       "JobName": "string",
#       "JobStatus": "string",
#       "LanguageCode": "string",
#       "Message": "string",
#       "Mode": "string",
#       "OutputDataConfig": {
#         "KmsKeyId": "string",
#         "S3Uri": "string"
#       },
#       "RedactionConfig": {
#         "MaskCharacter": "string",
#         "MaskMode": "string",
#         "PiiEntityTypes": [
#           "string"
#         ]
#       },
#       "SubmitTime": number
#     }
#   ]
# }