StartPHIDetectionJob
Starts an asynchronous job to detect protected health information (PHI). Use the
DescribePHIDetectionJob operation to track the status of a job.
Request Syntax
{
"ClientRequestToken": "string",
"DataAccessRoleArn": "string",
"InputDataConfig": {
"S3Bucket": "string",
"S3Key": "string"
},
"JobName": "string",
"KMSKey": "string",
"LanguageCode": "string",
"OutputDataConfig": {
"S3Bucket": "string",
"S3Key": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-]+$Required: No
- DataAccessRoleArn
-
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+Required: Yes
- InputDataConfig
-
Specifies the format and location of the input data for the job.
Type: InputDataConfig object
Required: Yes
- JobName
-
The identifier of the job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$Required: No
- KMSKey
-
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
.*Required: No
- LanguageCode
-
The language of the input documents. All documents must be in the same language.
Type: String
Valid Values:
enRequired: Yes
- OutputDataConfig
-
Specifies where to send the output files.
Type: OutputDataConfig object
Required: Yes
Response Syntax
{
"JobId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- JobId
-
The identifier generated for the job. To get the status of a job, use this identifier with the
DescribePHIDetectionJoboperation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
HTTP Status Code: 400
- TooManyRequestsException
-
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
