DescribeTargetedSentimentDetectionJob operation to track the status of a job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartTargetedSentimentDetectionJobResponse'
examples:
StartTargetedSentimentDetectionJob200Example:
summary: Default StartTargetedSentimentDetectionJob 200
x-microcks-default: true
value:
JobId: example
JobArn: example
JobStatus: example
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
examples:
StartTargetedSentimentDetectionJob480Example:
summary: Default StartTargetedSentimentDetectionJob 480
x-microcks-default: true
value: example
'481':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
StartTargetedSentimentDetectionJob481Example:
summary: Default StartTargetedSentimentDetectionJob 481
x-microcks-default: true
value: example
'482':
description: KmsKeyValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/KmsKeyValidationException'
examples:
StartTargetedSentimentDetectionJob482Example:
summary: Default StartTargetedSentimentDetectionJob 482
x-microcks-default: true
value: example
'483':
description: TooManyTagsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyTagsException'
examples:
StartTargetedSentimentDetectionJob483Example:
summary: Default StartTargetedSentimentDetectionJob 483
x-microcks-default: true
value: example
'484':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
examples:
StartTargetedSentimentDetectionJob484Example:
summary: Default StartTargetedSentimentDetectionJob 484
x-microcks-default: true
value: example
'485':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
StartTargetedSentimentDetectionJob485Example:
summary: Default StartTargetedSentimentDetectionJob 485
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartTargetedSentimentDetectionJobRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Comprehend_20171127.StartTargetedSentimentDetectionJob
summary: Amazon Comprehend Start Targeted Sentiment Detection Job
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=Comprehend 20171127.StartTargetedSentimentDetectionJob'
components:
schemas:
IamRoleArn:
type: string
pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
minLength: 20
maxLength: 2048
LanguageCode:
type: string
enum:
- en
- es
- fr
- de
- it
- pt
- ar
- hi
- ja
- ko
- zh
- zh-TW
SecurityGroupId:
type: string
pattern: '[-0-9a-zA-Z]+'
minLength: 1
maxLength: 32
SubnetId:
type: string
pattern: '[-0-9a-zA-Z]+'
minLength: 1
maxLength: 32
ClientRequestTokenString:
type: string
pattern: ^[a-zA-Z0-9-]+$
minLength: 1
maxLength: 64
DocumentReadMode:
type: string
enum:
- SERVICE_DEFAULT
- FORCE_DOCUMENT_READ_ACTION
TooManyTagsException: {}
JobStatus:
type: string
enum:
- SUBMITTED
- IN_PROGRESS
- COMPLETED
- FAILED
- STOP_REQUESTED
- STOPPED
KmsKeyId:
type: string
pattern: ^\p{ASCII}+$
maxLength: 2048
S3Uri:
type: string
pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
maxLength: 1024
Subnets:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 16
DocumentReaderConfig:
type: object
required:
- DocumentReadAction
properties:
DocumentReadAction:
allOf:
- $ref: '#/components/schemas/DocumentReadAction'
- description: This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the DetectDocumentText API operation.
TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument API operation.
Determines the text extraction actions for PDF files. Enter one of the following values:
SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF files.
FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns information about any tables that are detected in the input document.
FORMS - Returns information and the data from any forms that are detected in the input document.
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
Word files - Amazon Comprehend parser extracts the text.
Digital PDF files - Amazon Comprehend parser extracts the text.
Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.
DocumentReaderConfig does not apply to plain text files or Word files.
For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options in the Comprehend Developer Guide.
' JobId: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ minLength: 1 maxLength: 32 InputFormat: type: string enum: - ONE_DOC_PER_FILE - ONE_DOC_PER_LINE OutputDataConfig: type: object required: - S3Uri properties: S3Uri: allOf: - $ref: '#/components/schemas/S3Uri' - description:When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.
For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key Alias: "alias/ExampleAlias"
ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
Provides configuration parameters for the output of inference jobs.
JobName: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$ minLength: 1 maxLength: 256 InvalidRequestException: {} DocumentReadFeatureTypes: type: string enum: - TABLES - FORMS description:Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:
TABLES - Returns additional information about any tables that are detected in the input document.
FORMS - Returns additional information about any forms that are detected in the input document.
DescribeTargetedSentimentDetectionJob operation.
JobArn:
allOf:
- $ref: '#/components/schemas/ComprehendArn'
- description: 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:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
The status of the job.
SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.
The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.
For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.
Specifies how the text in an input file should be processed:
ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"