Chilkat Online Tools

DescribePiiEntitiesDetectionJob Powershell Example

Amazon Comprehend

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object Chilkat.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 = "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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

# 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 = New-Object Chilkat.JsonObject
$json.UpdateString("JobId","string")

# The JSON request body created by the above code:

# {
#   "JobId": "string"
# }

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

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object Chilkat.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

$DataAccessRoleArn = $jResp.StringOf("PiiEntitiesDetectionJobProperties.DataAccessRoleArn")
$EndTime = $jResp.IntOf("PiiEntitiesDetectionJobProperties.EndTime")
$DocumentReadAction = $jResp.StringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadAction")
$DocumentReadMode = $jResp.StringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadMode")
$InputFormat = $jResp.StringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.InputFormat")
$S3Uri = $jResp.StringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.S3Uri")
$JobArn = $jResp.StringOf("PiiEntitiesDetectionJobProperties.JobArn")
$JobId = $jResp.StringOf("PiiEntitiesDetectionJobProperties.JobId")
$JobName = $jResp.StringOf("PiiEntitiesDetectionJobProperties.JobName")
$JobStatus = $jResp.StringOf("PiiEntitiesDetectionJobProperties.JobStatus")
$LanguageCode = $jResp.StringOf("PiiEntitiesDetectionJobProperties.LanguageCode")
$Message = $jResp.StringOf("PiiEntitiesDetectionJobProperties.Message")
$Mode = $jResp.StringOf("PiiEntitiesDetectionJobProperties.Mode")
$KmsKeyId = $jResp.StringOf("PiiEntitiesDetectionJobProperties.OutputDataConfig.KmsKeyId")
$OutputDataConfigS3Uri = $jResp.StringOf("PiiEntitiesDetectionJobProperties.OutputDataConfig.S3Uri")
$MaskCharacter = $jResp.StringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.MaskCharacter")
$MaskMode = $jResp.StringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.MaskMode")
$SubmitTime = $jResp.IntOf("PiiEntitiesDetectionJobProperties.SubmitTime")
$i = 0
$count_i = $jResp.SizeOfArray("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("PiiEntitiesDetectionJobProperties.RedactionConfig.PiiEntityTypes")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.PiiEntityTypes[i]")
    $i = $i + 1
}

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

# {
#   "PiiEntitiesDetectionJobProperties": {
#     "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
#   }
# }