StartEntitiesDetectionV2Job
Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job 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 (p. 112).
The request accepts the following data in JSON format.
ClientRequestToken (p. 54)
A unique identifier for the request. If you don't set the client request token, Comprehend Medical;
generates one for you.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9-]+$
Required: No
DataAccessRoleArn (p. 54)
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 (p. 54)
The input configuration that specifies the format and location of the input data for the job.
Response Syntax
Type: InputDataConfig (p. 95) object Required: Yes
JobName (p. 54)
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 (p. 54)
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 (p. 54)
The language of the input documents. All documents must be in the same language. Comprehend Medical; processes files in US English (en).
Type: String Valid Values: en Required: Yes
OutputDataConfig (p. 54)
The output configuration that specifies where to send the output files.
Type: OutputDataConfig (p. 96) 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.
Errors
JobId (p. 55)
The identifier generated for the job. To get the status of a job, use this identifier with the DescribeEntitiesDetectionV2Job operation.
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 (p. 114).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartICD10CMInferenceJob
StartICD10CMInferenceJob
Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob 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 (p. 112).
The request accepts the following data in JSON format.
ClientRequestToken (p. 57)
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 (p. 57)
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 (p. 57)
Specifies the format and location of the input data for the job.
Response Syntax
Type: InputDataConfig (p. 95) object Required: Yes
JobName (p. 57)
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 (p. 57)
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 (p. 57)
The language of the input documents. All documents must be in the same language.
Type: String Valid Values: en Required: Yes
OutputDataConfig (p. 57)
Specifies where to send the output files.
Type: OutputDataConfig (p. 96) 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 (p. 58)
The identifier generated for the job. To get the status of a job, use this identifier with the StartICD10CMInferenceJob operation.
Errors
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 (p. 114).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartPHIDetectionJob
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 (p. 112).
The request accepts the following data in JSON format.
ClientRequestToken (p. 60)
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 (p. 60)
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 (p. 60)
Specifies the format and location of the input data for the job.
Response Syntax
Type: InputDataConfig (p. 95) object Required: Yes
JobName (p. 60)
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 (p. 60)
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 (p. 60)
The language of the input documents. All documents must be in the same language.
Type: String Valid Values: en Required: Yes
OutputDataConfig (p. 60)
Specifies where to send the output files.
Type: OutputDataConfig (p. 96) 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 (p. 61)
The identifier generated for the job. To get the status of a job, use this identifier with the DescribePHIDetectionJob operation.
Errors
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 (p. 114).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartRxNormInferenceJob
StartRxNormInferenceJob
Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob 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 (p. 112).
The request accepts the following data in JSON format.
ClientRequestToken (p. 63)
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 (p. 63)
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 (p. 63)
Specifies the format and location of the input data for the job.
Response Syntax
Type: InputDataConfig (p. 95) object Required: Yes
JobName (p. 63)
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 (p. 63)
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 (p. 63)
The language of the input documents. All documents must be in the same language.
Type: String Valid Values: en Required: Yes
OutputDataConfig (p. 63)
Specifies where to send the output files.
Type: OutputDataConfig (p. 96) 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 (p. 64)
The identifier of the job.
Errors
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 (p. 114).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartSNOMEDCTInferenceJob
StartSNOMEDCTInferenceJob
Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob 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 (p. 112).
The request accepts the following data in JSON format.
ClientRequestToken (p. 66)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[a-zA-Z0-9-]+$
Required: No
DataAccessRoleArn (p. 66)
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Required: Yes InputDataConfig (p. 66)
The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.
Response Syntax
Type: InputDataConfig (p. 95) object Required: Yes
JobName (p. 66)
The user generated name the asynchronous InferSNOMEDCT job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No KMSKey (p. 66)
An AWS Key Management Service key used 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 (p. 66)
The language of the input documents. All documents must be in the same language.
Type: String Valid Values: en Required: Yes
OutputDataConfig (p. 66)
The output properties for a detection job.
Type: OutputDataConfig (p. 96) 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 (p. 67)
The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.
Errors
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 (p. 114).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3