Amazon Comprehend · JSON Structure

Openapi.Yml Start Targeted Sentiment Detection Job Response Structure

StartTargetedSentimentDetectionJobResponse schema

Type: object Properties: 3
Machine LearningNatural Language ProcessingNLPText Analysis

StartTargetedSentimentDetectionJobResponse is a JSON Structure definition published by Amazon Comprehend, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

JobId JobArn JobStatus

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-start-targeted-sentiment-detection-job-response-structure.json",
  "name": "StartTargetedSentimentDetectionJobResponse",
  "description": "StartTargetedSentimentDetectionJobResponse schema",
  "type": "object",
  "properties": {
    "JobId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/JobId"
        },
        {
          "description": "The identifier generated for the job. To get the status of a job, use this identifier with the <code>DescribeTargetedSentimentDetectionJob</code> operation."
        }
      ]
    },
    "JobArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendArn"
        },
        {
          "description": "<p>The Amazon Resource Name (ARN) of the targeted sentiment 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:&lt;partition&gt;:comprehend:&lt;region&gt;:&lt;account-id&gt;:targeted-sentiment-detection-job/&lt;job-id&gt;</code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-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 <code>DescribeTargetedSentimentDetectionJob</code> operation.</p> </li> </ul>"
        }
      ]
    }
  }
}