Amazon Comprehend · Schema
StartEntitiesDetectionJobResponse
StartEntitiesDetectionJobResponse schema
Machine LearningNatural Language ProcessingNLPText Analysis
Properties
| Name | Type | Description |
|---|---|---|
| JobId | object | |
| JobArn | object | |
| JobStatus | object | |
| EntityRecognizerArn | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-start-entities-detection-job-response-schema.json",
"title": "StartEntitiesDetectionJobResponse",
"description": "StartEntitiesDetectionJobResponse schema",
"type": "object",
"properties": {
"JobId": {
"allOf": [
{
"$ref": "#/components/schemas/JobId"
},
{
"description": "The identifier generated for the job. To get the status of job, use this identifier with the operation."
}
]
},
"JobArn": {
"allOf": [
{
"$ref": "#/components/schemas/ComprehendArn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:</p> <p> <code>arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id></code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>"
}
]
},
"JobStatus": {
"allOf": [
{
"$ref": "#/components/schemas/JobStatus"
},
{
"description": "<p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the operation.</p> </li> <li> <p>STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.</p> </li> <li> <p>STOPPED - The job was successfully stopped without completing.</p> </li> </ul>"
}
]
},
"EntityRecognizerArn": {
"allOf": [
{
"$ref": "#/components/schemas/EntityRecognizerArn"
},
{
"description": "The ARN of the custom entity recognition model."
}
]
}
}
}