TargetedSentimentDetectionJobProperties
Provides information about a targeted sentiment detection job.
Contents
- DataAccessRoleArn
-
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend 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: No
- EndTime
-
The time that the targeted sentiment detection job ended.
Type: Timestamp
Required: No
- InputDataConfig
-
The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.
Type: InputDataConfig object
Required: No
- JobArn
-
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, AWS 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
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?
Required: No
- JobId
-
The identifier assigned to the targeted sentiment detection job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No
- JobName
-
The name that you assigned to the targeted sentiment detection job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
Required: No
- JobStatus
-
The current status of the targeted sentiment detection job. If the status is
FAILED
, theMessages
field shows the reason for the failure.Type: String
Valid Values:
SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED
Required: No
- LanguageCode
-
The language code of the input documents.
Type: String
Valid Values:
en
Required: No
- Message
-
A description of the status of a job.
Type: String
Required: No
- OutputDataConfig
-
Provides configuration parameters for the output of inference jobs.
Type: OutputDataConfig object
Required: No
- SubmitTime
-
The time that the targeted sentiment detection job was submitted for processing.
Type: Timestamp
Required: No
- VolumeKmsKeyId
-
ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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"
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^\p{ASCII}+$
Required: No
-
- VpcConfig
-
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
Type: VpcConfig object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: